From daea35fe73bf7a3e40e52ca046f7c929688d503c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 10 Oct 2023 17:47:07 +0000 Subject: [PATCH] chore(docs): Generated JS Client Reference (#5334) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- docs-util/packages/scripts/package.json | 1 + .../packages/typedoc-config/js-client.js | 7 +- .../typedoc-plugin-frontmatter/package.json | 1 - .../src/resolve-references-plugin.ts | 8 + docs-util/yarn.lock | 10 + .../medusa/src/interfaces/payment-service.ts | 6 +- .../discounts/admin/manage-discounts.mdx | 4 +- .../js-client/classes/AddressesResource.md | 28 +- .../references/js-client/classes/Admin.md | 120 +- .../js-client/classes/AdminAuthResource.md | 69 +- .../classes/AdminBatchJobsResource.md | 44 +- .../classes/AdminCollectionsResource.md | 116 +- .../classes/AdminCurrenciesResource.md | 54 +- .../js-client/classes/AdminCustomResource.md | 99 + .../classes/AdminCustomerGroupsResource.md | 82 +- .../classes/AdminCustomersResource.md | 42 +- .../classes/AdminDiscountsResource.md | 348 +- .../classes/AdminDraftOrdersResource.md | 226 +- .../classes/AdminGiftCardsResource.md | 116 +- .../classes/AdminInventoryItemsResource.md | 302 + .../js-client/classes/AdminInvitesResource.md | 48 +- .../js-client/classes/AdminNotesResource.md | 50 +- .../classes/AdminNotificationsResource.md | 24 +- .../classes/AdminOrderEditsResource.md | 112 +- .../js-client/classes/AdminOrdersResource.md | 234 +- .../AdminPaymentCollectionsResource.md | 40 +- .../classes/AdminPaymentsResource.md | 32 +- .../classes/AdminPriceListResource.md | 118 +- .../classes/AdminProductCategoriesResource.md | 222 + .../classes/AdminProductTagsResource.md | 12 +- .../classes/AdminProductTypesResource.md | 14 +- .../classes/AdminProductsResource.md | 140 +- .../classes/AdminPublishableApiKeyResource.md | 84 +- .../js-client/classes/AdminRegionsResource.md | 236 +- .../classes/AdminReservationsResource.md | 167 + .../classes/AdminReturnReasonsResource.md | 88 +- .../js-client/classes/AdminReturnsResource.md | 56 +- .../classes/AdminSalesChannelsResource.md | 182 +- .../classes/AdminShippingOptionsResource.md | 90 +- .../classes/AdminShippingProfilesResource.md | 48 +- .../classes/AdminStockLocationsResource.md | 165 + .../js-client/classes/AdminStoresResource.md | 114 +- .../js-client/classes/AdminSwapsResource.md | 22 +- .../classes/AdminTaxRatesResource.md | 128 +- .../js-client/classes/AdminUploadsResource.md | 80 +- .../js-client/classes/AdminUsersResource.md | 116 +- .../classes/AdminVariantsResource.md | 71 +- .../js-client/classes/AuthResource.md | 87 +- .../js-client/classes/CartsResource.md | 106 +- .../js-client/classes/CollectionsResource.md | 38 +- .../js-client/classes/CustomerResource.md | 66 +- .../js-client/classes/GiftCardsResource.md | 20 +- .../js-client/classes/LineItemsResource.md | 32 +- .../js-client/classes/OrderEditsResource.md | 22 +- .../js-client/classes/OrdersResource.md | 106 +- .../classes/PaymentCollectionsResource.md | 60 +- .../classes/PaymentMethodsResource.md | 12 +- .../classes/ProductCategoriesResource.md | 62 + .../js-client/classes/ProductTagsResource.md | 36 + .../js-client/classes/ProductTypesResource.md | 22 +- .../classes/ProductVariantsResource.md | 38 +- .../js-client/classes/ProductsResource.md | 58 +- .../js-client/classes/RegionsResource.md | 36 +- .../classes/ReturnReasonsResource.md | 28 +- .../js-client/classes/ReturnsResource.md | 14 +- .../classes/ShippingOptionsResource.md | 38 +- .../js-client/classes/SwapsResource.md | 38 +- .../classes/internal-1.AdminPostAuthReq.md | 25 +- .../classes/internal-1.BaseEntity.md | 75 + .../classes/internal-1.SoftDeletableEntity.md | 147 + .../js-client/classes/internal-1.User.md | 40 +- ...rnal-10.AdminPostInvitesInviteAcceptReq.md | 23 - ...-10.AdminPostInvitesInviteAcceptUserReq.md | 33 - .../internal-10.AdminPostInvitesReq.md | 23 - .../js-client/classes/internal-10.Invite.md | 137 - .../internal-11.AdminGetNotesParams.md | 33 - .../internal-11.AdminPostNotesNoteReq.md | 13 - .../classes/internal-11.AdminPostNotesReq.md | 33 - .../js-client/classes/internal-11.Note.md | 137 - ...internal-12.AdminGetNotificationsParams.md | 93 - ...nPostNotificationsNotificationResendReq.md | 13 - ...internal.Axios.md => internal-12.Axios.md} | 66 +- .../js-client/classes/internal-12.Client.md | 186 + .../classes/internal-12.Notification.md | 183 - .../internal-12.NotificationProvider.md | 23 - ...nPostOrderEditsEditLineItemsLineItemReq.md | 13 - ...-13.AdminPostOrderEditsEditLineItemsReq.md | 33 - ...rnal-13.AdminPostOrderEditsOrderEditReq.md | 13 - .../internal-13.AdminPostOrderEditsReq.md | 23 - ...nternal-13.GetOrderEditsOrderEditParams.md | 37 - .../classes/internal-14.AdditionalItem-1.md | 23 - .../classes/internal-14.AdditionalItem.md | 23 - .../internal-14.AdminGetOrdersParams.md | 273 - ...stOrdersOrderClaimsClaimFulfillmentsReq.md | 23 - ...l-14.AdminPostOrdersOrderClaimsClaimReq.md | 43 - ...nPostOrdersOrderClaimsClaimShipmentsReq.md | 23 - ...ternal-14.AdminPostOrdersOrderClaimsReq.md | 93 - ...-14.AdminPostOrdersOrderFulfillmentsReq.md | 33 - ...ernal-14.AdminPostOrdersOrderRefundsReq.md | 43 - .../internal-14.AdminPostOrdersOrderReq.md | 103 - ...ernal-14.AdminPostOrdersOrderReturnsReq.md | 63 - ...rnal-14.AdminPostOrdersOrderShipmentReq.md | 33 - ....AdminPostOrdersOrderShippingMethodsReq.md | 33 - ...nternal-14.AdminPostOrdersOrderSwapsReq.md | 63 - ...PostOrdersOrderSwapsSwapFulfillmentsReq.md | 23 - ...minPostOrdersOrderSwapsSwapShipmentsReq.md | 33 - .../internal-14.CustomShippingOption.md | 23 - .../js-client/classes/internal-14.Image.md | 23 - .../js-client/classes/internal-14.Item-1.md | 63 - .../js-client/classes/internal-14.Item-2.md | 63 - .../js-client/classes/internal-14.Item.md | 23 - .../classes/internal-14.PaymentMethod.md | 23 - .../classes/internal-14.ReturnItem.md | 43 - .../classes/internal-14.ReturnShipping-1.md | 23 - .../classes/internal-14.ReturnShipping-2.md | 23 - .../classes/internal-14.ReturnShipping.md | 23 - .../classes/internal-14.ShippingMethod-1.md | 33 - .../classes/internal-14.ShippingMethod-2.md | 33 - .../classes/internal-14.ShippingMethod.md | 53 - .../js-client/classes/internal-14.Tag.md | 23 - ...nal-15.AdminUpdatePaymentCollectionsReq.md | 23 - ...internal-15.GetPaymentCollectionsParams.md | 37 - .../internal-16.AdminPostPaymentRefundsReq.md | 33 - .../classes/internal-16.GetPaymentsParams.md | 37 - ...-17.AdminDeletePriceListPricesPricesReq.md | 13 - ...al-17.AdminGetPriceListPaginationParams.md | 189 - ...al-17.AdminPostPriceListPricesPricesReq.md | 23 - ...dminPostPriceListsPriceListPriceListReq.md | 93 - ...rnal-17.AdminPostPriceListsPriceListReq.md | 93 - .../classes/internal-17.CustomerGroup-1.md | 13 - .../classes/internal-17.CustomerGroup.md | 13 - ...-18.AdminGetProductTagsPaginationParams.md | 29 - .../internal-18.AdminGetProductTagsParams.md | 107 - ...nternal-2.AdminGetBatchPaginationParams.md | 14 +- .../classes/internal-2.AdminGetBatchParams.md | 32 +- .../classes/internal-2.AdminPostBatchesReq.md | 48 +- .../js-client/classes/internal-2.BatchJob.md | 58 +- .../internal-2.DateComparisonOperator.md | 12 +- .../internal-20.AdminGetProductsParams.md | 275 - ...-20.AdminPostProductsProductMetadataReq.md | 23 - ...0.AdminPostProductsProductOptionsOption.md | 13 - ...l-20.AdminPostProductsProductOptionsReq.md | 13 - ...internal-20.AdminPostProductsProductReq.md | 223 - ...-20.AdminPostProductsProductVariantsReq.md | 193 - ...inPostProductsProductVariantsVariantReq.md | 193 - .../internal-20.AdminPostProductsReq.md | 243 - .../classes/internal-20.ProductOptionReq.md | 13 - .../internal-20.ProductSalesChannelReq.md | 13 - .../classes/internal-20.ProductTagReq.md | 23 - .../classes/internal-20.ProductTypeReq.md | 23 - .../internal-20.ProductVariantOptionReq-1.md | 23 - .../internal-20.ProductVariantOptionReq-2.md | 13 - .../internal-20.ProductVariantOptionReq-3.md | 23 - .../internal-20.ProductVariantOptionReq.md | 23 - .../internal-20.ProductVariantReq-1.md | 203 - .../classes/internal-20.ProductVariantReq.md | 193 - ...ePublishableApiKeySalesChannelsBatchReq.md | 13 - ...tPublishableApiKeySalesChannelsBatchReq.md | 13 - ...tPublishableApiKeysPublishableApiKeyReq.md | 13 - ...ernal-21.AdminPostPublishableApiKeysReq.md | 13 - ...GetPublishableApiKeySalesChannelsParams.md | 3 - .../internal-21.ProductBatchSalesChannel.md | 13 - .../classes/internal-21.PublishableApiKey.md | 103 - ...rnal-22.AdminGetRegionsPaginationParams.md | 29 - .../internal-22.AdminGetRegionsParams.md | 67 - ...inGetRegionsRegionFulfillmentOptionsRes.md | 13 - ...l-22.AdminPostRegionsRegionCountriesReq.md | 13 - ...ostRegionsRegionFulfillmentProvidersReq.md | 13 - ...minPostRegionsRegionPaymentProvidersReq.md | 13 - .../internal-22.AdminPostRegionsRegionReq.md | 123 - .../internal-22.AdminPostRegionsReq.md | 93 - .../classes/internal-22.AdminRegionsRes.md | 13 - .../classes/internal-22.FulfillmentOption.md | 23 - ...rnal-23.AdminPostReturnReasonsReasonReq.md | 43 - .../internal-23.AdminPostReturnReasonsReq.md | 53 - .../internal-24.AdminGetReturnsParams.md | 23 - ...nal-24.AdminPostReturnsReturnReceiveReq.md | 23 - .../js-client/classes/internal-24.Item.md | 23 - ...eteSalesChannelsChannelProductsBatchReq.md | 13 - ...ostSalesChannelsChannelProductsBatchReq.md | 13 - .../internal-25.AdminPostSalesChannelsReq.md | 33 - ...5.AdminPostSalesChannelsSalesChannelReq.md | 33 - ...ternal-26.AdminGetShippingOptionsParams.md | 33 - ...al-26.AdminPostShippingOptionsOptionReq.md | 63 - ...internal-26.AdminPostShippingOptionsReq.md | 123 - .../internal-26.OptionRequirement-1.md | 33 - .../classes/internal-26.OptionRequirement.md | 23 - ...-27.AdminPostShippingProfilesProfileReq.md | 13 - ...nternal-27.AdminPostShippingProfilesReq.md | 13 - .../classes/internal-28.AdminPostStoreReq.md | 73 - .../js-client/classes/internal-28.Store.md | 163 - .../internal-29.AdminGetSwapsParams.md | 23 - .../js-client/classes/internal-3.Address.md | 221 + ...-3.AdminDeleteProductsFromCollectionReq.md | 20 +- ...l-3.AdminGetCollectionsPaginationParams.md | 8 +- .../internal-3.AdminGetCollectionsParams.md | 22 +- ...nal-3.AdminPostCollectionsCollectionReq.md | 30 +- .../internal-3.AdminPostCollectionsReq.md | 32 +- ...rnal-3.AdminPostProductsToCollectionReq.md | 20 +- .../js-client/classes/internal-3.Cart.md | 471 + .../classes/internal-3.ClaimImage.md | 121 + .../js-client/classes/internal-3.ClaimItem.md | 201 + .../classes/internal-3.ClaimOrder.md | 251 + .../js-client/classes/internal-3.ClaimTag.md | 101 + ...ernal.Country.md => internal-3.Country.md} | 20 +- ...nal.Currency.md => internal-3.Currency.md} | 12 +- .../js-client/classes/internal-3.Customer.md | 201 + .../classes/internal-3.CustomerGroup.md | 121 + .../js-client/classes/internal-3.Discount.md | 221 + .../classes/internal-3.DiscountCondition.md | 181 + .../classes/internal-3.DiscountRule.md | 141 + .../classes/internal-3.DraftOrder.md | 177 + .../classes/internal-3.Fulfillment.md | 247 + .../classes/internal-3.FulfillmentItem.md | 57 + ...r.md => internal-3.FulfillmentProvider.md} | 6 +- .../js-client/classes/internal-3.GiftCard.md | 191 + .../classes/internal-3.GiftCardTransaction.md | 107 + .../js-client/classes/internal-3.Image.md | 101 + .../js-client/classes/internal-3.LineItem.md | 495 + .../classes/internal-3.LineItemAdjustment.md | 97 + .../classes/internal-3.LineItemTaxLine.md | 143 + .../classes/internal-3.MoneyAmount.md | 221 + .../js-client/classes/internal-3.Order.md | 587 + ...l.OrderEdit.md => internal-3.OrderEdit.md} | 82 +- .../classes/internal-3.OrderItemChange.md | 151 + .../js-client/classes/internal-3.Payment.md | 227 + .../classes/internal-3.PaymentCollection.md | 211 + ...vider.md => internal-3.PaymentProvider.md} | 6 +- .../classes/internal-3.PaymentSession.md | 167 + .../js-client/classes/internal-3.PriceList.md | 171 + .../js-client/classes/internal-3.Product.md | 411 + .../classes/internal-3.ProductCategory.md | 187 + .../classes/internal-3.ProductCollection.md | 121 + .../classes/internal-3.ProductOption.md | 131 + .../classes/internal-3.ProductOptionValue.md | 141 + .../classes/internal-3.ProductTag.md | 101 + .../classes/internal-3.ProductType.md | 101 + .../classes/internal-3.ProductVariant.md | 321 + .../internal-3.ProductVariantInventoryItem.md | 121 + .../js-client/classes/internal-3.Refund.md | 157 + .../js-client/classes/internal-3.Region.md | 231 + .../js-client/classes/internal-3.Return.md | 227 + .../classes/internal-3.ReturnItem.md | 127 + .../classes/internal-3.ReturnReason.md | 151 + .../classes/internal-3.SalesChannel.md | 131 + .../internal-3.SalesChannelLocation.md | 111 + .../classes/internal-3.ShippingMethod.md | 217 + .../internal-3.ShippingMethodTaxLine.md | 143 + .../classes/internal-3.ShippingOption.md | 231 + .../internal-3.ShippingOptionRequirement.md | 77 + .../classes/internal-3.ShippingProfile.md | 131 + .../js-client/classes/internal-3.Swap.md | 281 + .../js-client/classes/internal-3.TaxLine.md | 101 + ...xProvider.md => internal-3.TaxProvider.md} | 6 +- .../js-client/classes/internal-3.TaxRate.md | 187 + .../classes/internal-3.TrackingLink.md | 141 + ...DeleteTaxRatesTaxRateProductTypesParams.md | 23 - ...minDeleteTaxRatesTaxRateProductTypesReq.md | 13 - ...dminDeleteTaxRatesTaxRateProductsParams.md | 23 - ...0.AdminDeleteTaxRatesTaxRateProductsReq.md | 13 - ...eteTaxRatesTaxRateShippingOptionsParams.md | 23 - ...DeleteTaxRatesTaxRateShippingOptionsReq.md | 13 - .../internal-30.AdminGetTaxRatesParams.md | 83 - ...ternal-30.AdminGetTaxRatesTaxRateParams.md | 23 - .../internal-30.AdminPostTaxRatesReq.md | 73 - ...AdminPostTaxRatesTaxRateProductTypesReq.md | 13 - ...-30.AdminPostTaxRatesTaxRateProductsReq.md | 13 - ...internal-30.AdminPostTaxRatesTaxRateReq.md | 73 - ...inPostTaxRatesTaxRateShippingOptionsReq.md | 13 - ...internal-30.NumericalComparisonOperator.md | 43 - .../internal-31.AdminDeleteUploadsReq.md | 13 - ...ernal-31.AdminPostUploadsDownloadUrlReq.md | 13 - .../internal-31.IAdminPostUploadsFileReq.md | 23 - .../internal-32.AdminCreateUserRequest.md | 53 - .../internal-32.AdminResetPasswordRequest.md | 33 - ...ernal-32.AdminResetPasswordTokenRequest.md | 13 - .../internal-32.AdminUpdateUserRequest.md | 53 - .../internal-33.AdminGetVariantsParams.md | 145 - .../internal-33.AdminPriceSelectionParams.md | 63 - .../internal-33.PriceSelectionParams.md | 43 - .../classes/internal-34.StorePostAuthReq.md | 23 - .../js-client/classes/internal-35.Discount.md | 13 - .../js-client/classes/internal-35.GiftCard.md | 13 - .../js-client/classes/internal-35.Item.md | 23 - .../classes/internal-35.StorePostCartReq.md | 53 - ...-35.StorePostCartsCartPaymentSessionReq.md | 13 - ...orePostCartsCartPaymentSessionUpdateReq.md | 13 - .../internal-35.StorePostCartsCartReq.md | 103 - ...-35.StorePostCartsCartShippingMethodReq.md | 23 - ...CustomersCustomerOrdersPaginationParams.md | 49 - ...7.StoreGetCustomersCustomerOrdersParams.md | 205 - ...rePostCustomersCustomerPasswordTokenReq.md | 13 - ...ternal-37.StorePostCustomersCustomerReq.md | 73 - .../internal-37.StorePostCustomersReq.md | 53 - ...l-37.StorePostCustomersResetPasswordReq.md | 33 - ...l-39.StorePostCartsCartLineItemsItemReq.md | 13 - ...ernal-39.StorePostCartsCartLineItemsReq.md | 33 - .../internal-4.AdminGetCurrenciesParams.md | 14 +- ...ternal-4.AdminPostCurrenciesCurrencyReq.md | 16 +- .../internal-4.FindPaginationParams.md | 14 +- ...-40.StorePostOrderEditsOrderEditDecline.md | 13 - .../internal-41.ShippingAddressPayload.md | 13 - .../internal-41.StoreGetOrdersParams.md | 33 - ...torePostCustomersCustomerAcceptClaimReq.md | 13 - ...StorePostCustomersCustomerOrderClaimReq.md | 13 - ...al-42.StorePaymentCollectionSessionsReq.md | 13 - ...entCollectionsBatchSessionsAuthorizeReq.md | 13 - ...ePostPaymentCollectionsBatchSessionsReq.md | 13 - ....StorePostPaymentCollectionsSessionsReq.md | 33 - .../internal-45.StoreGetVariantsParams.md | 121 - ...nal-46.StoreGetProductsPaginationParams.md | 93 - .../internal-46.StoreGetProductsParams.md | 227 - .../classes/internal-46.StorePostSearchReq.md | 43 - .../js-client/classes/internal-49.Item.md | 43 - .../classes/internal-49.ReturnShipping.md | 13 - .../internal-49.StorePostReturnsReq.md | 33 - ...leteCustomerGroupsGroupCustomerBatchReq.md | 13 - ...nal-5.AdminGetCustomerGroupsGroupParams.md | 37 - ...internal-5.AdminGetCustomerGroupsParams.md | 133 - .../internal-5.AdminGetCustomersParams.md | 67 - .../internal-5.AdminListCustomerSelector.md | 29 - ...ostCustomerGroupsGroupCustomersBatchReq.md | 13 - ...ernal-5.AdminPostCustomerGroupsGroupReq.md | 23 - .../internal-5.AdminPostCustomerGroupsReq.md | 23 - .../internal-5.CustomerGroupsBatchCustomer.md | 13 - .../classes/internal-5.FindParams.md | 43 - .../internal-5.StringComparisonOperator.md | 43 - ...ternal-50.StoreGetShippingOptionsParams.md | 33 - .../classes/internal-51.AdditionalItem.md | 23 - .../js-client/classes/internal-51.Item.md | 43 - .../classes/internal-51.StorePostSwapsReq.md | 43 - ...leteCustomerGroupsGroupCustomerBatchReq.md | 36 + ...nal-6.AdminGetCustomerGroupsGroupParams.md | 41 + ...internal-6.AdminGetCustomerGroupsParams.md | 137 + ...ostCustomerGroupsGroupCustomersBatchReq.md | 36 + ...ernal-6.AdminPostCustomerGroupsGroupReq.md | 42 + .../internal-6.AdminPostCustomerGroupsReq.md | 44 + ...nternal-6.AdminPostCustomersCustomerReq.md | 73 - .../internal-6.AdminPostCustomersReq.md | 63 - .../internal-6.CustomerGroupsBatchCustomer.md | 17 + ...nternal-6.FilterableCustomerGroupProps.md} | 22 +- .../classes/internal-6.FindParams.md | 145 + .../js-client/classes/internal-6.Group.md | 13 - .../internal-6.StringComparisonOperator.md | 77 + .../internal-7.AdminCreateCondition.md | 89 - ...untsDiscountConditionsConditionBatchReq.md | 13 - .../internal-7.AdminGetCustomersParams.md | 85 + ...l-7.AdminGetDiscountsDiscountRuleParams.md | 23 - .../internal-7.AdminListCustomerSelector.md | 43 + ...nternal-7.AdminPostCustomersCustomerReq.md | 117 + .../internal-7.AdminPostCustomersReq.md | 101 + ...-7.AdminPostDiscountsDiscountConditions.md | 89 - ...ostDiscountsDiscountConditionsCondition.md | 79 - ...untsDiscountConditionsConditionBatchReq.md | 13 - ...minPostDiscountsDiscountDynamicCodesReq.md | 33 - ...nternal-7.AdminPostDiscountsDiscountReq.md | 93 - ...ternal-7.AdminPostDiscountsDiscountRule.md | 53 - .../internal-7.AdminPostDiscountsReq.md | 103 - .../internal-7.AdminUpdateDiscountRule.md | 53 - .../internal-7.AdminUpsertCondition.md | 99 - .../js-client/classes/internal-7.Group.md | 17 + ...nternal-8.AbstractEventBusModuleService.md | 168 + .../internal-8.AbstractSearchService.md | 288 + .../classes/internal-8.AdditionalItem-1.md | 27 + .../classes/internal-8.AdditionalItem-2.md | 27 + .../classes/internal-8.AdditionalItem.md | 27 + .../internal-8.AdminCreateCondition.md | 93 + ...untsDiscountConditionsConditionBatchReq.md | 36 + ...ountsDiscountConditionsConditionParams.md} | 16 +- ...l-8.AdminGetDiscountsDiscountRuleParams.md | 27 + ... => internal-8.AdminGetDiscountsParams.md} | 26 +- .../internal-8.AdminGetDraftOrdersParams.md | 33 - ... => internal-8.AdminListOrdersSelector.md} | 40 +- ...-8.AdminPostDiscountsDiscountConditions.md | 131 + ...ostDiscountsDiscountConditionsCondition.md | 114 + ...DiscountConditionsConditionBatchParams.md} | 16 +- ...untsDiscountConditionsConditionBatchReq.md | 36 + ...ountsDiscountConditionsConditionParams.md} | 16 +- ...nPostDiscountsDiscountConditionsParams.md} | 16 +- ...minPostDiscountsDiscountDynamicCodesReq.md | 58 + ...nternal-8.AdminPostDiscountsDiscountReq.md | 195 + ...ternal-8.AdminPostDiscountsDiscountRule.md | 57 + .../internal-8.AdminPostDiscountsReq.md | 214 + ...stDraftOrdersDraftOrderLineItemsItemReq.md | 43 - ...inPostDraftOrdersDraftOrderLineItemsReq.md | 53 - ...nal-8.AdminPostDraftOrdersDraftOrderReq.md | 83 - .../internal-8.AdminPostDraftOrdersReq.md | 113 - .../internal-8.AdminPriceSelectionParams.md | 95 + ...nternal-8.AdminProductCategoriesReqBase.md | 65 + .../internal-8.AdminUpdateDiscountRule.md | 57 + .../internal-8.AdminUpsertCondition.md | 103 + ...=> internal-8.AdminUpsertConditionsReq.md} | 24 +- .../js-client/classes/internal-8.Blob.md | 137 + .../internal-8.CustomShippingOption.md | 27 + .../classes/internal-8.CustomerGroup-1.md | 17 + .../classes/internal-8.CustomerGroup.md | 17 + .../classes/internal-8.CustomerGroupUpdate.md | 27 + .../classes/internal-8.Discount-1.md | 6 +- .../classes/internal-8.Discount-2.md | 17 + .../classes/internal-8.Discount-3.md | 17 + .../js-client/classes/internal-8.Discount.md | 6 +- .../js-client/classes/internal-8.Duplex.md | 4811 ++++++++ .../classes/internal-8.EventEmitter-1.md | 1174 ++ .../classes/internal-8.FilterableCartProps.md | 37 + .../internal-8.FilterableDiscountProps.md | 57 + ...nal-8.FilterableLineItemAdjustmentProps.md | 67 + ...d => internal-8.FilterableProductProps.md} | 62 +- ...nternal-8.FilterableProductVariantProps.md | 217 + .../classes/internal-8.FlagRouter.md | 102 + .../classes/internal-8.FulfillmentService.md | 452 + .../classes/internal-8.GiftCard-1.md | 17 + .../js-client/classes/internal-8.GiftCard.md | 17 + .../js-client/classes/internal-8.Image.md | 27 + .../js-client/classes/internal-8.Item-1.md | 67 + .../js-client/classes/internal-8.Item-2.md | 27 + .../js-client/classes/internal-8.Item-3.md | 67 + .../js-client/classes/internal-8.Item-4.md | 27 + .../js-client/classes/internal-8.Item-5.md | 47 + .../js-client/classes/internal-8.Item-6.md | 47 + .../js-client/classes/internal-8.Item.md | 16 +- .../classes/internal-8.MedusaError.md | 205 + .../internal-8.NotificationProvider.md | 27 + .../classes/internal-8.OptionRequirement-1.md | 37 + .../classes/internal-8.OptionRequirement.md | 27 + ...Item.md => internal-8.OrdersReturnItem.md} | 14 +- .../classes/internal-8.PassThrough.md | 4446 ++++++++ .../classes/internal-8.PaymentMethod.md | 27 + .../classes/internal-8.PaymentService.md | 366 + .../internal-8.PriceSelectionParams.md | 79 + .../internal-8.ProductBatchProductCategory.md | 17 + .../internal-8.ProductBatchSalesChannel.md | 17 + .../classes/internal-8.ProductOptionReq.md | 17 + .../internal-8.ProductProductCategoryReq.md | 17 + .../internal-8.ProductSalesChannelReq.md | 17 + .../classes/internal-8.ProductTagReq.md | 27 + .../classes/internal-8.ProductTypeReq.md | 27 + .../internal-8.ProductVariantOptionReq-1.md | 27 + .../internal-8.ProductVariantOptionReq-2.md | 17 + .../internal-8.ProductVariantOptionReq-3.md | 27 + .../internal-8.ProductVariantOptionReq.md | 27 + ...ternal-8.ProductVariantPricesCreateReq.md} | 16 +- ...ternal-8.ProductVariantPricesUpdateReq.md} | 18 +- .../classes/internal-8.ProductVariantReq-1.md | 207 + .../classes/internal-8.ProductVariantReq.md | 197 + .../js-client/classes/internal-8.Readable.md | 3202 ++++++ .../classes/internal-8.ReadableBase.md | 3356 ++++++ .../classes/internal-8.ReturnItem.md | 47 + .../classes/internal-8.ReturnShipping-1.md | 27 + .../classes/internal-8.ReturnShipping-2.md | 27 + .../classes/internal-8.ReturnShipping-3.md | 17 + .../classes/internal-8.ReturnShipping.md | 27 + .../classes/internal-8.ShippingMethod-1.md | 47 + .../classes/internal-8.ShippingMethod-2.md | 47 + .../classes/internal-8.ShippingMethod-3.md | 57 + .../classes/internal-8.ShippingMethod.md | 12 +- .../internal-8.StockLocationAddress-1.md | 87 + .../internal-8.StockLocationAddress.md | 129 + .../js-client/classes/internal-8.Stream.md | 1228 +++ .../js-client/classes/internal-8.Tag.md | 27 + .../js-client/classes/internal-8.Transform.md | 4450 ++++++++ .../classes/internal-8.WritableBase.md | 2964 +++++ .../classes/internal-8.internal-2.Writable.md | 2844 +++++ .../classes/internal-8.internal-5.md | 1222 +++ ...nal-8.internal.AbstractBatchJobStrategy.md | 406 + ...internal.AbstractCartCompletionStrategy.md | 223 + ...internal-8.internal.AbstractFileService.md | 388 + ...l-8.internal.AbstractFulfillmentService.md | 392 + ...-8.internal.AbstractNotificationService.md | 304 + ...nal-8.internal.AbstractPaymentProcessor.md | 326 + ...ernal-8.internal.AbstractPaymentService.md | 653 ++ ...internal.AbstractPriceSelectionStrategy.md | 253 + .../internal-8.internal.AbstractTaxService.md | 76 + ...ernal-8.internal.AdminCreateUserRequest.md | 84 + ...sDiscountConditionsConditionBatchParams.md | 41 + ...countsDiscountConditionsConditionParams.md | 41 + ...nal.AdminDeletePriceListPricesPricesReq.md | 28 + ...iceListsPriceListProductsPricesBatchReq.md | 28 + ...ctCategoriesCategoryProductsBatchParams.md | 41 + ...oductCategoriesCategoryProductsBatchReq.md | 36 + ...ePublishableApiKeySalesChannelsBatchReq.md | 36 + ...eteSalesChannelsChannelProductsBatchReq.md | 36 + ...teSalesChannelsChannelStockLocationsReq.md | 28 + ...DeleteTaxRatesTaxRateProductTypesParams.md | 27 + ...minDeleteTaxRatesTaxRateProductTypesReq.md | 30 + ...dminDeleteTaxRatesTaxRateProductsParams.md | 27 + ...l.AdminDeleteTaxRatesTaxRateProductsReq.md | 30 + ...eteTaxRatesTaxRateShippingOptionsParams.md | 27 + ...DeleteTaxRatesTaxRateShippingOptionsReq.md | 30 + ...ternal-8.internal.AdminDeleteUploadsReq.md | 28 + ...ernal-8.internal.AdminGetDiscountParams.md | 41 + ...nal.AdminGetDiscountsDiscountCodeParams.md | 41 + ...al-8.internal.AdminGetDraftOrdersParams.md | 37 + ...rnal-8.internal.AdminGetGiftCardsParams.md | 37 + ...tInventoryItemsItemLocationLevelsParams.md | 51 + ...ternal.AdminGetInventoryItemsItemParams.md | 41 + ...8.internal.AdminGetInventoryItemsParams.md | 199 + ...internal-8.internal.AdminGetNotesParams.md | 37 + ...-8.internal.AdminGetNotificationsParams.md | 97 + ...al-8.internal.AdminGetOrdersOrderParams.md | 41 + ...nternal-8.internal.AdminGetOrdersParams.md | 277 + ...ternal.AdminGetPaymentCollectionsParams.md | 41 + ...ernal.AdminGetPriceListPaginationParams.md | 193 + ...inGetPriceListsPriceListProductsParams.md} | 46 +- ...nternal.AdminGetProductCategoriesParams.md | 129 + ....internal.AdminGetProductCategoryParams.md | 41 + ...nal.AdminGetProductTagsPaginationParams.md | 33 + ...al-8.internal.AdminGetProductTagsParams.md | 111 + ...-8.internal.AdminGetProductTypesParams.md} | 28 +- ...ernal-8.internal.AdminGetProductsParams.md | 317 + ...internal.AdminGetProductsVariantsParams.md | 47 + ...nternal.AdminGetRegionsPaginationParams.md | 33 + ...ternal-8.internal.AdminGetRegionsParams.md | 71 + ...inGetRegionsRegionFulfillmentOptionsRes.md | 46 + ...l-8.internal.AdminGetReservationsParams.md | 139 + ...ternal-8.internal.AdminGetReturnsParams.md | 27 + ...8.internal.AdminGetSalesChannelsParams.md} | 32 +- ....internal.AdminGetShippingOptionsParams.md | 37 + ...al.AdminGetStockLocationsLocationParams.md | 41 + ...8.internal.AdminGetStockLocationsParams.md | 109 + ...internal-8.internal.AdminGetSwapsParams.md | 27 + ...ernal-8.internal.AdminGetTaxRatesParams.md | 87 + ....internal.AdminGetTaxRatesTaxRateParams.md | 27 + ...ternal-8.internal.AdminGetVariantParams.md | 41 + ...ernal-8.internal.AdminGetVariantsParams.md | 157 + ...inPostAnalyticsConfigAnalyticsConfigReq.md | 27 + ...-8.internal.AdminPostAnalyticsConfigReq.md | 27 + ...ternal.AdminPostDiscountsDiscountParams.md | 41 + ...nal-8.internal.AdminPostDiscountsParams.md | 41 + ...stDraftOrdersDraftOrderLineItemsItemReq.md | 68 + ...inPostDraftOrdersDraftOrderLineItemsReq.md | 84 + ...ernal.AdminPostDraftOrdersDraftOrderReq.md | 133 + ...rnal-8.internal.AdminPostDraftOrdersReq.md | 214 + ....internal.AdminPostGiftCardsGiftCardReq.md | 82 + ...ternal-8.internal.AdminPostGiftCardsReq.md | 84 + ...inPostInventoryItemsInventoryItemParams.md | 41 + ...AdminPostInventoryItemsInventoryItemReq.md | 170 + ...ntoryItemsItemLocationLevelsLevelParams.md | 41 + ...nventoryItemsItemLocationLevelsLevelReq.md | 39 + ...tInventoryItemsItemLocationLevelsParams.md | 41 + ...PostInventoryItemsItemLocationLevelsReq.md | 55 + ....internal.AdminPostInventoryItemsParams.md | 41 + ...l-8.internal.AdminPostInventoryItemsReq.md | 211 + ...nternal.AdminPostInvitesInviteAcceptReq.md | 57 + ...nal.AdminPostInvitesInviteAcceptUserReq.md | 37 + ...internal-8.internal.AdminPostInvitesReq.md | 44 + ...ternal-8.internal.AdminPostNotesNoteReq.md | 28 + .../internal-8.internal.AdminPostNotesReq.md | 56 + ...nPostNotificationsNotificationResendReq.md | 26 + ...nPostOrderEditsEditLineItemsLineItemReq.md | 28 + ...nal.AdminPostOrderEditsEditLineItemsReq.md | 58 + ...nternal.AdminPostOrderEditsOrderEditReq.md | 26 + ...ernal-8.internal.AdminPostOrderEditsReq.md | 51 + ...minPostOrderEditsRequestConfirmationReq.md | 17 + ...l-8.internal.AdminPostOrdersClaimCancel.md | 41 + ...PostOrdersClaimFulfillmentsCancelParams.md | 41 + ...ernal.AdminPostOrdersOrderArchiveParams.md | 41 + ...l-8.internal.AdminPostOrdersOrderCancel.md | 41 + ...ernal.AdminPostOrdersOrderCaptureParams.md | 41 + ...rdersOrderClaimsClaimFulfillmentsParams.md | 41 + ...stOrdersOrderClaimsClaimFulfillmentsReq.md | 52 + ...l.AdminPostOrdersOrderClaimsClaimParams.md | 41 + ...rnal.AdminPostOrdersOrderClaimsClaimReq.md | 140 + ...stOrdersOrderClaimsClaimShipmentsParams.md | 41 + ...nPostOrdersOrderClaimsClaimShipmentsReq.md | 43 + ...ternal.AdminPostOrdersOrderClaimsParams.md | 41 + ....internal.AdminPostOrdersOrderClaimsReq.md | 215 + ...rnal.AdminPostOrdersOrderCompleteParams.md | 41 + ...ostOrdersOrderFulfillementsCancelParams.md | 41 + ....AdminPostOrdersOrderFulfillmentsParams.md | 41 + ...nal.AdminPostOrdersOrderFulfillmentsReq.md | 79 + ...l-8.internal.AdminPostOrdersOrderParams.md | 41 + ...ernal.AdminPostOrdersOrderRefundsParams.md | 41 + ...internal.AdminPostOrdersOrderRefundsReq.md | 68 + ...rnal-8.internal.AdminPostOrdersOrderReq.md | 172 + ...ernal.AdminPostOrdersOrderReturnsParams.md | 41 + ...internal.AdminPostOrdersOrderReturnsReq.md | 129 + ...rnal.AdminPostOrdersOrderShipmentParams.md | 41 + ...nternal.AdminPostOrdersOrderShipmentReq.md | 56 + ...minPostOrdersOrderShippingMethodsParams.md | 41 + ....AdminPostOrdersOrderShippingMethodsReq.md | 55 + ...rdersOrderSwapFulfillementsCancelParams.md | 41 + ...nternal.AdminPostOrdersOrderSwapsParams.md | 41 + ...8.internal.AdminPostOrdersOrderSwapsReq.md | 165 + ...tOrdersOrderSwapsSwapFulfillmentsParams.md | 41 + ...PostOrdersOrderSwapsSwapFulfillmentsReq.md | 52 + ...rdersOrderSwapsSwapProcessPaymentParams.md | 41 + ...PostOrdersOrderSwapsSwapShipmentsParams.md | 41 + ...minPostOrdersOrderSwapsSwapShipmentsReq.md | 56 + ...nternal.AdminPostOrdersSwapCancelParams.md | 41 + ...l-8.internal.AdminPostPaymentRefundsReq.md | 55 + ...ernal.AdminPostPriceListPricesPricesReq.md | 69 + ...dminPostPriceListsPriceListPriceListReq.md | 177 + ...nternal.AdminPostPriceListsPriceListReq.md | 179 + ...dminPostProductCategoriesCategoryParams.md | 41 + ...ctCategoriesCategoryProductsBatchParams.md | 41 + ...oductCategoriesCategoryProductsBatchReq.md | 36 + ...l.AdminPostProductCategoriesCategoryReq.md | 130 + ...ternal.AdminPostProductCategoriesParams.md | 41 + ....internal.AdminPostProductCategoriesReq.md | 119 + ...nal.AdminPostProductsProductMetadataReq.md | 42 + ...l.AdminPostProductsProductOptionsOption.md | 28 + ...rnal.AdminPostProductsProductOptionsReq.md | 29 + ...-8.internal.AdminPostProductsProductReq.md | 458 + ...nal.AdminPostProductsProductVariantsReq.md | 307 + ...inPostProductsProductVariantsVariantReq.md | 304 + ...nternal-8.internal.AdminPostProductsReq.md | 497 + ...tPublishableApiKeySalesChannelsBatchReq.md | 36 + ...tPublishableApiKeysPublishableApiKeyReq.md | 26 + ...internal.AdminPostPublishableApiKeysReq.md | 28 + ...rnal.AdminPostRegionsRegionCountriesReq.md | 31 + ...ostRegionsRegionFulfillmentProvidersReq.md | 28 + ...minPostRegionsRegionPaymentProvidersReq.md | 28 + ...al-8.internal.AdminPostRegionsRegionReq.md | 179 + ...internal-8.internal.AdminPostRegionsReq.md | 145 + ...nal-8.internal.AdminPostReservationsReq.md | 95 + ...nal.AdminPostReservationsReservationReq.md | 65 + ...nternal.AdminPostReturnReasonsReasonReq.md | 68 + ...al-8.internal.AdminPostReturnReasonsReq.md | 84 + ...ternal.AdminPostReturnsReturnReceiveReq.md | 63 + ...ostSalesChannelsChannelProductsBatchReq.md | 36 + ...stSalesChannelsChannelStockLocationsReq.md | 28 + ...al-8.internal.AdminPostSalesChannelsReq.md | 54 + ...l.AdminPostSalesChannelsSalesChannelReq.md | 52 + ...ernal.AdminPostShippingOptionsOptionReq.md | 115 + ...-8.internal.AdminPostShippingOptionsReq.md | 199 + ...nal.AdminPostShippingProfilesProfileReq.md | 82 + ...8.internal.AdminPostShippingProfilesReq.md | 53 + ...l.AdminPostStockLocationsLocationParams.md | 41 + ...rnal.AdminPostStockLocationsLocationReq.md | 68 + ....internal.AdminPostStockLocationsParams.md | 41 + ...l-8.internal.AdminPostStockLocationsReq.md | 71 + .../internal-8.internal.AdminPostStoreReq.md | 118 + ...rnal-8.internal.AdminPostTaxRatesParams.md | 27 + ...nternal-8.internal.AdminPostTaxRatesReq.md | 114 + ...internal.AdminPostTaxRatesTaxRateParams.md | 27 + ...inPostTaxRatesTaxRateProductTypesParams.md | 27 + ...AdminPostTaxRatesTaxRateProductTypesReq.md | 30 + ....AdminPostTaxRatesTaxRateProductsParams.md | 27 + ...nal.AdminPostTaxRatesTaxRateProductsReq.md | 30 + ...-8.internal.AdminPostTaxRatesTaxRateReq.md | 110 + ...ostTaxRatesTaxRateShippingOptionsParams.md | 27 + ...inPostTaxRatesTaxRateShippingOptionsReq.md | 30 + ...internal.AdminPostUploadsDownloadUrlReq.md | 28 + ...internal.AdminPriceListPricesCreateReq.md} | 18 +- ...internal.AdminPriceListPricesUpdateReq.md} | 20 +- .../internal-8.internal.AdminRegionsRes.md | 37 + ...al-8.internal.AdminResetPasswordRequest.md | 57 + ...internal.AdminResetPasswordTokenRequest.md | 29 + ...ternal.AdminUpdatePaymentCollectionsReq.md | 42 + ...ernal-8.internal.AdminUpdateUserRequest.md | 82 + .../internal-8.internal.AnalyticsConfig.md | 111 + ...ernal-8.internal.AnalyticsConfigService.md | 296 + .../internal-8.internal.AuthService.md | 317 + .../internal-8.internal.BatchJobService.md | 497 + .../internal-8.internal.CartService.md | 1499 +++ .../internal-8.internal.ClaimItemService.md | 345 + .../internal-8.internal.ClaimService.md | 625 ++ .../internal-8.internal.CurrencyService.md | 311 + ...nternal-8.internal.CustomShippingOption.md | 141 + ...-8.internal.CustomShippingOptionService.md | 279 + ...nternal-8.internal.CustomerGroupService.md | 412 + .../internal-8.internal.CustomerService.md | 669 ++ ...internal.DiscountConditionCustomerGroup.md | 77 + ...nal-8.internal.DiscountConditionProduct.md | 77 + ...rnal.DiscountConditionProductCollection.md | 77 + ...-8.internal.DiscountConditionProductTag.md | 77 + ...8.internal.DiscountConditionProductType.md | 77 + ...nal-8.internal.DiscountConditionService.md | 314 + .../internal-8.internal.DiscountService.md | 843 ++ .../internal-8.internal.DraftOrderService.md | 498 + .../internal-8.internal.EmptyQueryParams.md | 7 + .../internal-8.internal.EventBusService.md | 447 + ...rnal-8.internal.FilterableBatchJobProps.md | 67 + ...al-8.internal.FilterablePriceListProps.md} | 32 +- .../internal-8.internal.FulfillmentOption.md | 27 + ...l-8.internal.FulfillmentProviderService.md | 459 + ...8.internal.GetOrderEditsOrderEditParams.md | 41 + ...nternal-8.internal.GetOrderEditsParams.md} | 20 +- .../internal-8.internal.GetPaymentsParams.md | 41 + ...GetPublishableApiKeySalesChannelsParams.md | 79 + ...8.internal.GetPublishableApiKeysParams.md} | 18 +- .../internal-8.internal.GiftCardService.md | 496 + ...nal-8.internal.IAdminPostUploadsFileReq.md | 27 + .../internal-8.internal.IdempotencyKey.md | 117 + ...ternal-8.internal.IdempotencyKeyService.md | 353 + .../classes/internal-8.internal.Invite.md | 141 + .../classes/internal-8.internal.Item.md | 27 + ...al-8.internal.LineItemAdjustmentService.md | 410 + .../internal-8.internal.LineItemService.md | 605 ++ .../internal-8.internal.MiddlewareService.md | 244 + .../internal-8.internal.NewTotalsService.md | 495 + .../classes/internal-8.internal.Note.md | 141 + .../internal-8.internal.NoteService.md | 374 + .../internal-8.internal.Notification.md | 187 + ...internal-8.internal.NotificationService.md | 496 + ...-8.internal.NumericalComparisonOperator.md | 47 + .../classes/internal-8.internal.Oauth.md | 77 + .../internal-8.internal.OauthService.md | 398 + ...l-8.internal.OrderEditItemChangeService.md | 327 + .../internal-8.internal.OrderEditService.md | 707 ++ .../internal-8.internal.OrderService.md | 1155 ++ ...nal-8.internal.PaymentCollectionService.md | 483 + ...ernal-8.internal.PaymentProviderService.md | 832 ++ .../internal-8.internal.PriceListService.md | 653 ++ .../internal-8.internal.PricingService.md | 540 + ...ernal-8.internal.ProductCategoryService.md | 549 + ...nal-8.internal.ProductCollectionService.md | 457 + .../internal-8.internal.ProductService.md | 866 ++ .../internal-8.internal.ProductTaxRate.md | 77 + .../internal-8.internal.ProductTypeService.md | 274 + .../internal-8.internal.ProductTypeTaxRate.md | 77 + ...internal.ProductVariantInventoryService.md | 674 ++ ...al-8.internal.ProductVariantMoneyAmount.md | 101 + ...ternal-8.internal.ProductVariantService.md | 869 ++ .../internal-8.internal.PublishableApiKey.md | 107 + ....internal.PublishableApiKeySalesChannel.md | 27 + .../internal-8.internal.RegionService.md | 781 ++ ...internal-8.internal.ReturnReasonService.md | 307 + .../internal-8.internal.ReturnService.md | 601 + ...8.internal.SalesChannelInventoryService.md | 243 + ...-8.internal.SalesChannelLocationService.md | 318 + ...internal-8.internal.SalesChannelService.md | 519 + .../internal-8.internal.SearchService.md | 302 + ...ernal-8.internal.ShippingAddressPayload.md | 17 + ...ternal-8.internal.ShippingOptionService.md | 663 ++ ...ernal-8.internal.ShippingProfileService.md | 635 ++ .../internal-8.internal.ShippingTaxRate.md | 77 + .../classes/internal-8.internal.StagedJob.md | 57 + .../internal-8.internal.StagedJobService.md | 260 + .../classes/internal-8.internal.Store.md | 177 + ...l-8.internal.StoreGetCollectionsParams.md} | 16 +- ...CustomersCustomerOrdersPaginationParams.md | 53 + ...l.StoreGetCustomersCustomerOrdersParams.md | 209 + ...nternal-8.internal.StoreGetOrdersParams.md | 71 + ...ternal.StoreGetPaymentCollectionsParams.md | 41 + ...StoreGetProductCategoriesCategoryParams.md | 41 + ...nternal.StoreGetProductCategoriesParams.md | 109 + ...al-8.internal.StoreGetProductTagsParams.md | 111 + ...-8.internal.StoreGetProductTypesParams.md} | 28 +- ...ternal.StoreGetProductsPaginationParams.md | 115 + ...ernal-8.internal.StoreGetProductsParams.md | 265 + ...ternal-8.internal.StoreGetRegionsParams.md | 47 + ....internal.StoreGetShippingOptionsParams.md | 37 + ...ernal-8.internal.StoreGetVariantsParams.md | 153 + ....internal.StoreGetVariantsVariantParams.md | 93 + ...ernal.StorePaymentCollectionSessionsReq.md | 28 + .../internal-8.internal.StorePostAuthReq.md | 42 + .../internal-8.internal.StorePostCartReq.md | 102 + ...rnal.StorePostCartsCartLineItemsItemReq.md | 44 + ...internal.StorePostCartsCartLineItemsReq.md | 58 + ...nal.StorePostCartsCartPaymentSessionReq.md | 28 + ...orePostCartsCartPaymentSessionUpdateReq.md | 28 + ...ternal-8.internal.StorePostCartsCartReq.md | 176 + ...nal.StorePostCartsCartShippingMethodReq.md | 41 + ...torePostCustomersCustomerAcceptClaimReq.md | 28 + ...StorePostCustomersCustomerOrderClaimReq.md | 30 + ...rePostCustomersCustomerPasswordTokenReq.md | 29 + ....internal.StorePostCustomersCustomerReq.md | 111 + ...ternal-8.internal.StorePostCustomersReq.md | 85 + ...rnal.StorePostCustomersResetPasswordReq.md | 58 + ...nal.StorePostOrderEditsOrderEditDecline.md | 26 + ...entCollectionsBatchSessionsAuthorizeReq.md | 30 + ...ePostPaymentCollectionsBatchSessionsReq.md | 43 + ....StorePostPaymentCollectionsSessionsReq.md | 37 + ...internal-8.internal.StorePostReturnsReq.md | 79 + .../internal-8.internal.StorePostSearchReq.md | 64 + .../internal-8.internal.StorePostSwapsReq.md | 99 + .../internal-8.internal.StoreService.md | 354 + ...rnal-8.internal.StrategyResolverService.md | 218 + .../internal-8.internal.SwapService.md | 779 ++ ...8.internal.SystemPaymentProviderService.md | 398 + .../internal-8.internal.TaxProviderService.md | 560 + .../internal-8.internal.TaxRateService.md | 522 + .../internal-8.internal.TokenService.md | 69 + .../internal-8.internal.TotalsService.md | 826 ++ ...ernal-8.internal.TransactionBaseService.md | 280 + .../internal-8.internal.UserService.md | 504 + .../internal-9.AdminGetGiftCardsParams.md | 33 - ...nternal-9.AdminPostGiftCardsGiftCardReq.md | 53 - .../internal-9.AdminPostGiftCardsReq.md | 53 - .../js-client/classes/internal.Address.md | 221 - .../classes/internal.AddressCreatePayload.md | 81 +- .../classes/internal.AddressPayload.md | 76 +- .../js-client/classes/internal.BaseEntity.md | 73 - .../js-client/classes/internal.Cart.md | 461 - .../js-client/classes/internal.ClaimImage.md | 121 - .../js-client/classes/internal.ClaimItem.md | 201 - .../js-client/classes/internal.ClaimOrder.md | 251 - .../js-client/classes/internal.ClaimTag.md | 101 - .../js-client/classes/internal.Client.md | 186 - .../js-client/classes/internal.Customer.md | 201 - .../classes/internal.CustomerGroup.md | 121 - .../js-client/classes/internal.Discount.md | 221 - .../classes/internal.DiscountCondition.md | 181 - .../classes/internal.DiscountRule.md | 141 - .../js-client/classes/internal.DraftOrder.md | 177 - .../js-client/classes/internal.Fulfillment.md | 237 - .../classes/internal.FulfillmentItem.md | 57 - .../js-client/classes/internal.GiftCard.md | 181 - .../classes/internal.GiftCardTransaction.md | 107 - .../js-client/classes/internal.Image.md | 101 - .../js-client/classes/internal.LineItem.md | 447 - .../classes/internal.LineItemAdjustment.md | 97 - .../classes/internal.LineItemTaxLine.md | 143 - .../js-client/classes/internal.MoneyAmount.md | 191 - .../js-client/classes/internal.Order.md | 567 - .../classes/internal.OrderItemChange.md | 151 - .../js-client/classes/internal.Payment.md | 227 - .../classes/internal.PaymentCollection.md | 211 - .../classes/internal.PaymentSession.md | 157 - .../js-client/classes/internal.PriceList.md | 171 - .../js-client/classes/internal.Product.md | 371 - .../classes/internal.ProductCollection.md | 121 - .../classes/internal.ProductOption.md | 131 - .../classes/internal.ProductOptionValue.md | 141 - .../js-client/classes/internal.ProductTag.md | 101 - .../js-client/classes/internal.ProductType.md | 101 - .../classes/internal.ProductVariant.md | 301 - .../js-client/classes/internal.Refund.md | 157 - .../js-client/classes/internal.Region.md | 231 - .../js-client/classes/internal.Return.md | 217 - .../js-client/classes/internal.ReturnItem.md | 127 - .../classes/internal.ReturnReason.md | 151 - .../classes/internal.SalesChannel.md | 111 - .../classes/internal.ShippingMethod.md | 217 - .../classes/internal.ShippingMethodTaxLine.md | 143 - .../classes/internal.ShippingOption.md | 231 - .../internal.ShippingOptionRequirement.md | 77 - .../classes/internal.ShippingProfile.md | 131 - .../classes/internal.SoftDeletableEntity.md | 137 - ...ostCustomersCustomerAddressesAddressReq.md | 30 +- ....StorePostCustomersCustomerAddressesReq.md | 13 +- .../js-client/classes/internal.Swap.md | 281 - .../js-client/classes/internal.TaxLine.md | 101 - .../js-client/classes/internal.TaxRate.md | 187 - .../classes/internal.TrackingLink.md | 141 - .../js-client/enums/internal-1.UserRoles.md | 10 +- .../enums/internal-2.BatchJobStatus.md | 18 +- ...onType.md => internal-3.AllocationType.md} | 6 +- ...nal.CartType.md => internal-3.CartType.md} | 12 +- ...d => internal-3.ClaimFulfillmentStatus.md} | 20 +- ...us.md => internal-3.ClaimPaymentStatus.md} | 8 +- ...aimReason.md => internal-3.ClaimReason.md} | 10 +- ...l.ClaimType.md => internal-3.ClaimType.md} | 6 +- ...> internal-3.DiscountConditionOperator.md} | 6 +- ...md => internal-3.DiscountConditionType.md} | 12 +- ...Type.md => internal-3.DiscountRuleType.md} | 8 +- ...atus.md => internal-3.DraftOrderStatus.md} | 6 +- ...tus.md => internal-3.FulfillmentStatus.md} | 20 +- ... => internal-3.OrderEditItemChangeType.md} | 8 +- ...tatus.md => internal-3.OrderEditStatus.md} | 12 +- ...derStatus.md => internal-3.OrderStatus.md} | 12 +- ... => internal-3.PaymentCollectionStatus.md} | 12 +- ...tStatus.md => internal-3.PaymentStatus.md} | 16 +- ...tatus.md => internal-3.PriceListStatus.md} | 6 +- ...istType.md => internal-3.PriceListType.md} | 6 +- ...tStatus.md => internal-3.ProductStatus.md} | 10 +- ...tType.md => internal-3.RequirementType.md} | 6 +- ...rnStatus.md => internal-3.ReturnStatus.md} | 10 +- ... => internal-3.ShippingOptionPriceType.md} | 6 +- ...e.md => internal-3.ShippingProfileType.md} | 8 +- ...md => internal-3.SwapFulfillmentStatus.md} | 14 +- ...tus.md => internal-3.SwapPaymentStatus.md} | 20 +- .../enums/internal-8.DefaultPriceType.md | 13 + ...-8.DiscountConditionJoinTableForeignKey.md | 57 + .../enums/internal-8.FulfillmentStatus.md | 97 + .../enums/internal-8.MODULE_RESOURCE_TYPE.md | 27 + .../js-client/enums/internal-8.OrderStatus.md | 57 + .../enums/internal-8.PaymentStatus.md | 77 + ...ternal-8.internal.PaymentCollectionType.md | 13 + ...nternal-8.internal.PaymentSessionStatus.md | 57 + .../internal-8.internal.PostgresError.md | 47 + ...md => internal-8.internal.RefundReason.md} | 16 +- .../content/references/js-client/index.md | 52 +- .../interfaces/internal-10.BlobPropertyBag.md | 33 + .../js-client/interfaces/internal-10.File.md | 187 + .../interfaces/internal-10.FilePropertyBag.md | 51 + .../interfaces/internal-10.QueuingStrategy.md | 33 + .../internal-10.QueuingStrategySize.md | 33 + ...nternal-10.ReadableByteStreamController.md | 93 + .../interfaces/internal-10.ReadableStream.md | 168 + .../internal-10.ReadableStreamBYOBReader.md | 101 + .../internal-10.ReadableStreamBYOBRequest.md | 65 + ...rnal-10.ReadableStreamDefaultController.md | 87 + ...internal-10.ReadableStreamDefaultReader.md | 95 + ...internal-10.ReadableStreamGenericReader.md | 49 + ...ernal-10.ReadableStreamGetReaderOptions.md | 21 + ...nternal-10.ReadableStreamReadDoneResult.md | 33 + ...ternal-10.ReadableStreamReadValueResult.md | 33 + .../internal-10.ReadableWritablePair.md | 38 + .../internal-10.StreamPipeOptions.md | 63 + .../internal-10.UnderlyingByteSource.md | 85 + .../internal-10.UnderlyingDefaultSource.md | 81 + .../interfaces/internal-10.UnderlyingSink.md | 63 + ...internal-10.UnderlyingSinkAbortCallback.md | 27 + ...internal-10.UnderlyingSinkCloseCallback.md | 21 + ...internal-10.UnderlyingSinkStartCallback.md | 27 + ...internal-10.UnderlyingSinkWriteCallback.md | 34 + .../internal-10.UnderlyingSource.md | 63 + ...ernal-10.UnderlyingSourceCancelCallback.md | 27 + ...nternal-10.UnderlyingSourcePullCallback.md | 33 + ...ternal-10.UnderlyingSourceStartCallback.md | 33 + .../interfaces/internal-10.WritableStream.md | 83 + ...rnal-10.WritableStreamDefaultController.md | 45 + ...internal-10.WritableStreamDefaultWriter.md | 129 + .../interfaces/internal-12.AxiosAdapter.md | 27 + ...d => internal-12.AxiosBasicCredentials.md} | 6 +- ...faults.md => internal-12.AxiosDefaults.md} | 94 +- .../interfaces/internal-12.AxiosError.md | 130 + .../interfaces/internal-12.AxiosInstance.md | 377 + ...=> internal-12.AxiosInterceptorManager.md} | 6 +- .../interfaces/internal-12.AxiosPromise.md | 132 + ...fig.md => internal-12.AxiosProxyConfig.md} | 10 +- ...=> internal-12.AxiosRequestTransformer.md} | 6 +- ...sponse.md => internal-12.AxiosResponse.md} | 18 +- ...> internal-12.AxiosResponseTransformer.md} | 6 +- ...ternal.Cancel.md => internal-12.Cancel.md} | 4 +- .../interfaces/internal-12.CancelToken.md | 41 + .../interfaces/internal-12.Config.md | 57 + .../interfaces/internal-12.HTTPResponse.md | 57 + .../interfaces/internal-12.HeadersDefaults.md | 117 + ...ryConfig.md => internal-12.RetryConfig.md} | 38 +- ....md => internal-12.TransitionalOptions.md} | 8 +- .../interfaces/internal-3.Boolean.md | 23 + .../interfaces/internal-5.RequestOptions.md | 27 + .../interfaces/internal-8.ArrayBufferView.md | 43 + .../interfaces/internal-8.ArrayLike.md | 27 + .../interfaces/internal-8.AsyncGenerator.md | 107 + .../internal-8.AsyncGeneratorFunction.md | 65 + .../interfaces/internal-8.AsyncIterable.md | 27 + .../internal-8.AsyncIterableIterator.md | 105 + .../interfaces/internal-8.AsyncIterator.md | 83 + .../interfaces/internal-8.BlobOptions.md | 37 + .../js-client/interfaces/internal-8.Buffer.md | 4086 +++++++ .../internal-8.BufferConstructor.md | 606 ++ .../interfaces/internal-8.CallSite.md | 222 + .../interfaces/internal-8.CreateNoteInput.md | 67 + .../interfaces/internal-8.CreateUserInput.md | 77 + .../interfaces/internal-8.DuplexOptions.md | 345 + .../interfaces/internal-8.ErrnoException.md | 95 + .../js-client/interfaces/internal-8.Error.md | 37 + .../interfaces/internal-8.EventEmitter-2.md | 649 ++ .../internal-8.EventEmitter.Abortable.md | 27 + .../internal-8.EventEmitterOptions.md | 19 + .../interfaces/internal-8.FindConfig.md | 94 + .../interfaces/internal-8.ICacheService.md | 75 + .../internal-8.IEventBusModuleService.md | 105 + .../interfaces/internal-8.IEventBusService.md | 113 + .../interfaces/internal-8.IFlagRouter.md | 53 + .../internal-8.IInventoryService.md | 605 ++ .../interfaces/internal-8.ISearchService.md | 222 + .../internal-8.IStockLocationService.md | 151 + .../internal-8.ITransactionBaseService.md | 35 + .../interfaces/internal-8.Iterable.md | 27 + .../interfaces/internal-8.IterableIterator.md | 105 + .../interfaces/internal-8.Iterator.md | 81 + .../internal-8.IteratorReturnResult.md | 33 + .../internal-8.IteratorYieldResult.md | 33 + .../internal-8.JoinerServiceConfig.md | 83 + .../internal-8.JoinerServiceConfigAlias.md | 29 + .../js-client/interfaces/internal-8.Logger.md | 318 + .../internal-8.NumericalComparisonOperator.md | 47 + .../js-client/interfaces/internal-8.Object.md | 133 + .../interfaces/internal-8.PromiseLike.md | 45 + .../interfaces/internal-8.QueuingStrategy.md | 33 + .../internal-8.QueuingStrategySize.md | 33 + .../interfaces/internal-8.ReadWriteStream.md | 1074 ++ ...internal-8.ReadableByteStreamController.md | 81 + ...-8.ReadableByteStreamControllerCallback.md | 27 + .../interfaces/internal-8.ReadableStream-1.md | 156 + .../interfaces/internal-8.ReadableStream.md | 906 ++ ...ernal-8.ReadableStreamDefaultController.md | 77 + ...l-8.ReadableStreamDefaultReadDoneResult.md | 27 + ...-8.ReadableStreamDefaultReadValueResult.md | 33 + .../internal-8.ReadableStreamDefaultReader.md | 85 + .../internal-8.ReadableStreamErrorCallback.md | 27 + .../internal-8.ReadableStreamGenericReader.md | 43 + .../internal-8.ReadableWritablePair.md | 42 + .../internal-8.SharedArrayBuffer.md | 62 + ...internal-8.SharedArrayBufferConstructor.md | 17 + .../internal-8.StaticEventEmitterOptions.md | 17 + .../internal-8.StreamPipeOptions.md | 87 + .../internal-8.StringComparisonOperator.md | 77 + .../interfaces/internal-8.TransformOptions.md | 409 + .../internal-8.UnderlyingByteSource.md | 57 + .../interfaces/internal-8.UnderlyingSink.md | 63 + .../internal-8.UnderlyingSinkAbortCallback.md | 27 + .../internal-8.UnderlyingSinkCloseCallback.md | 21 + .../internal-8.UnderlyingSinkStartCallback.md | 27 + .../internal-8.UnderlyingSinkWriteCallback.md | 34 + .../interfaces/internal-8.UnderlyingSource.md | 53 + ...ternal-8.UnderlyingSourceCancelCallback.md | 27 + ...internal-8.UnderlyingSourcePullCallback.md | 33 + ...nternal-8.UnderlyingSourceStartCallback.md | 33 + .../interfaces/internal-8.UpdateUserInput.md | 77 + .../interfaces/internal-8.WritableStream-1.md | 75 + .../interfaces/internal-8.WritableStream.md | 815 ++ ...ernal-8.WritableStreamDefaultController.md | 32 + .../internal-8.WritableStreamDefaultWriter.md | 116 + .../interfaces/internal-8._DOMEventTarget.md | 30 + .../interfaces/internal-8._NodeEventTarget.md | 28 + .../internal-8.internal-2.FinishedOptions.md | 59 + .../interfaces/internal-8.internal-2.Pipe.md | 63 + .../internal-8.internal-2.PipelineOptions.md | 27 + .../internal-8.internal-2.ReadableOptions.md | 169 + .../internal-8.internal-2.StreamOptions.md | 122 + .../internal-8.internal-2.WritableOptions.md | 224 + .../internal-8.internal.CustomFindOptions.md | 64 + .../internal-8.internal.FindConfig.md | 67 + .../internal-8.internal.FulfillmentService.md | 310 + .../internal-8.internal.IBatchJobStrategy.md | 275 + ...rnal-8.internal.ICartCompletionStrategy.md | 38 + .../internal-8.internal.IFileService.md | 328 + ...nternal-8.internal.INotificationService.md | 236 + ...rnal-8.internal.IPriceSelectionStrategy.md | 90 + ...rnal-8.internal.ITaxCalculationStrategy.md | 34 + .../internal-8.internal.ITaxService.md | 42 + .../internal-8.internal.PaymentProcessor.md | 253 + ...ternal-8.internal.PaymentProcessorError.md | 37 + .../internal-8.internal.PaymentService.md | 567 + .../interfaces/internal.AxiosAdapter.md | 27 - .../interfaces/internal.AxiosError.md | 88 - .../interfaces/internal.AxiosInstance.md | 377 - .../interfaces/internal.AxiosPromise.md | 19 - .../interfaces/internal.AxiosRequestConfig.md | 385 - .../interfaces/internal.CancelToken.md | 41 - .../js-client/interfaces/internal.Config.md | 47 - .../interfaces/internal.HTTPResponse.md | 57 - .../interfaces/internal.HeadersDefaults.md | 117 - .../interfaces/internal.RequestOptions.md | 27 - .../js-client/modules/internal-1.md | 105 +- .../js-client/modules/internal-10.md | 472 +- .../js-client/modules/internal-11.md | 85 +- .../js-client/modules/internal-12.md | 119 +- .../js-client/modules/internal-13.md | 64 - .../js-client/modules/internal-14.md | 62 - .../js-client/modules/internal-15.md | 40 - .../js-client/modules/internal-16.md | 42 - .../js-client/modules/internal-17.md | 69 - .../js-client/modules/internal-18.md | 16 - .../js-client/modules/internal-19.md | 15 - .../js-client/modules/internal-2.md | 52 +- .../js-client/modules/internal-20.md | 211 - .../js-client/modules/internal-21.md | 58 - .../js-client/modules/internal-22.md | 24 - .../js-client/modules/internal-23.md | 38 - .../js-client/modules/internal-24.md | 49 - .../js-client/modules/internal-25.md | 35 - .../js-client/modules/internal-26.md | 35 - .../js-client/modules/internal-27.md | 38 - .../js-client/modules/internal-28.md | 54 - .../js-client/modules/internal-29.md | 31 - .../js-client/modules/internal-3.md | 211 +- .../js-client/modules/internal-30.md | 44 - .../js-client/modules/internal-31.md | 39 - .../js-client/modules/internal-32.md | 116 - .../js-client/modules/internal-33.md | 17 - .../js-client/modules/internal-34.md | 37 - .../js-client/modules/internal-35.md | 38 - .../js-client/modules/internal-36.md | 31 - .../js-client/modules/internal-37.md | 20 - .../js-client/modules/internal-38.md | 17 - .../js-client/modules/internal-39.md | 6 - .../js-client/modules/internal-4.md | 50 +- .../js-client/modules/internal-40.md | 21 - .../js-client/modules/internal-41.md | 24 - .../js-client/modules/internal-42.md | 40 - .../js-client/modules/internal-43.md | 17 - .../js-client/modules/internal-44.md | 15 - .../js-client/modules/internal-45.md | 31 - .../js-client/modules/internal-46.md | 53 - .../js-client/modules/internal-47.md | 33 - .../js-client/modules/internal-48.md | 33 - .../js-client/modules/internal-49.md | 23 - .../js-client/modules/internal-5.md | 55 +- .../js-client/modules/internal-50.md | 21 - .../js-client/modules/internal-51.md | 23 - .../js-client/modules/internal-6.md | 73 +- ...dusa_packages_medusa_dist_types_global_.md | 123 - .../js-client/modules/internal-7.md | 126 +- .../modules/internal-8.EventEmitter.md | 17 + .../modules/internal-8.internal-1.md | 643 ++ .../modules/internal-8.internal-2.finished.md | 28 + .../modules/internal-8.internal-2.md | 835 ++ .../modules/internal-8.internal-2.pipeline.md | 191 + .../modules/internal-8.internal-3.md | 212 + .../modules/internal-8.internal-4.md | 107 + .../js-client/modules/internal-8.internal.md | 9655 +++++++++++++++++ .../js-client/modules/internal-8.md | 7131 +++++++++++- .../js-client/modules/internal-9.md | 28 +- .../references/js-client/modules/internal.md | 213 +- 1091 files changed, 140791 insertions(+), 25954 deletions(-) create mode 100644 www/apps/docs/content/references/js-client/classes/AdminCustomResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/ProductTagsResource.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-10.Invite.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-11.Note.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md rename www/apps/docs/content/references/js-client/classes/{internal.Axios.md => internal-12.Axios.md} (56%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.Client.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.Notification.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-12.NotificationProvider.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsOrderEditParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.Image.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.Item-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.Item-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.PaymentMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ReturnItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-14.Tag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductTagReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeySalesChannelsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.ProductBatchSalesChannel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-24.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-28.Store.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Address.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Cart.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md rename www/apps/docs/content/references/js-client/classes/{internal.Country.md => internal-3.Country.md} (56%) rename www/apps/docs/content/references/js-client/classes/{internal.Currency.md => internal-3.Currency.md} (60%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Customer.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Discount.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md rename www/apps/docs/content/references/js-client/classes/{internal.FulfillmentProvider.md => internal-3.FulfillmentProvider.md} (55%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Image.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Order.md rename www/apps/docs/content/references/js-client/classes/{internal.OrderEdit.md => internal-3.OrderEdit.md} (53%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Payment.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md rename www/apps/docs/content/references/js-client/classes/{internal.PaymentProvider.md => internal-3.PaymentProvider.md} (57%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Product.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Refund.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Region.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Return.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.Swap.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md rename www/apps/docs/content/references/js-client/classes/{internal.TaxProvider.md => internal-3.TaxProvider.md} (58%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-3.TrackingLink.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.Discount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.GiftCard.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-42.StorePaymentCollectionSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsSessionsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-49.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-49.ReturnShipping.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.FindParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-51.AdditionalItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-51.Item.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md rename www/apps/docs/content/references/js-client/classes/{internal-5.FilterableCustomerGroupProps.md => internal-6.FilterableCustomerGroupProps.md} (58%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.FindParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.Group.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-7.Group.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md => internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md} (52%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminGetDiscountsParams.md => internal-8.AdminGetDiscountsParams.md} (58%) delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md rename www/apps/docs/content/references/js-client/classes/{internal-14.AdminListOrdersSelector.md => internal-8.AdminListOrdersSelector.md} (64%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md => internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md} (53%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md => internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md} (52%) rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminPostDiscountsDiscountConditionsParams.md => internal-8.AdminPostDiscountsDiscountConditionsParams.md} (50%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md rename www/apps/docs/content/references/js-client/classes/{internal-7.AdminUpsertConditionsReq.md => internal-8.AdminUpsertConditionsReq.md} (53%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Blob.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md rename www/apps/docs/content/references/js-client/classes/{internal-20.FilterableProductProps.md => internal-8.FilterableProductProps.md} (55%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Image.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md rename www/apps/docs/content/references/js-client/classes/{internal-14.OrdersReturnItem.md => internal-8.OrdersReturnItem.md} (53%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md rename www/apps/docs/content/references/js-client/classes/{internal-20.ProductVariantPricesCreateReq.md => internal-8.ProductVariantPricesCreateReq.md} (54%) rename www/apps/docs/content/references/js-client/classes/{internal-20.ProductVariantPricesUpdateReq.md => internal-8.ProductVariantPricesUpdateReq.md} (54%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Readable.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Stream.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Tag.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.Transform.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md rename www/apps/docs/content/references/js-client/classes/{internal-17.AdminGetPriceListsPriceListProductsParams.md => internal-8.internal.AdminGetPriceListsPriceListProductsParams.md} (54%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md rename www/apps/docs/content/references/js-client/classes/{internal-19.AdminGetProductTypesParams.md => internal-8.internal.AdminGetProductTypesParams.md} (58%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md rename www/apps/docs/content/references/js-client/classes/{internal-25.AdminGetSalesChannelsParams.md => internal-8.internal.AdminGetSalesChannelsParams.md} (56%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md rename www/apps/docs/content/references/js-client/classes/{internal-17.AdminPriceListPricesCreateReq.md => internal-8.internal.AdminPriceListPricesCreateReq.md} (54%) rename www/apps/docs/content/references/js-client/classes/{internal-17.AdminPriceListPricesUpdateReq.md => internal-8.internal.AdminPriceListPricesUpdateReq.md} (55%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md rename www/apps/docs/content/references/js-client/classes/{internal-17.FilterablePriceListProps.md => internal-8.internal.FilterablePriceListProps.md} (55%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md rename www/apps/docs/content/references/js-client/classes/{internal-13.GetOrderEditsParams.md => internal-8.internal.GetOrderEditsParams.md} (57%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md rename www/apps/docs/content/references/js-client/classes/{internal-21.GetPublishableApiKeysParams.md => internal-8.internal.GetPublishableApiKeysParams.md} (57%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md rename www/apps/docs/content/references/js-client/classes/{internal-36.StoreGetCollectionsParams.md => internal-8.internal.StoreGetCollectionsParams.md} (50%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md rename www/apps/docs/content/references/js-client/classes/{internal-44.StoreGetProductTypesParams.md => internal-8.internal.StoreGetProductTypesParams.md} (58%) create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md create mode 100644 www/apps/docs/content/references/js-client/classes/internal-8.internal.UserService.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Address.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.BaseEntity.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Cart.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ClaimImage.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ClaimItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ClaimOrder.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ClaimTag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Client.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Customer.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.CustomerGroup.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Discount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.DiscountCondition.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.DiscountRule.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.DraftOrder.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Fulfillment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.FulfillmentItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.GiftCard.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.GiftCardTransaction.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Image.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.LineItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.LineItemAdjustment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.LineItemTaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.MoneyAmount.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Order.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.OrderItemChange.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Payment.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.PaymentCollection.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.PaymentSession.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.PriceList.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Product.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductCollection.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductOptionValue.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductTag.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductType.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ProductVariant.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Refund.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Region.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Return.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ReturnItem.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ReturnReason.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.SalesChannel.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ShippingMethod.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ShippingOption.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.ShippingProfile.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.Swap.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.TaxLine.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.TaxRate.md delete mode 100644 www/apps/docs/content/references/js-client/classes/internal.TrackingLink.md rename www/apps/docs/content/references/js-client/enums/{internal.AllocationType.md => internal-3.AllocationType.md} (58%) rename www/apps/docs/content/references/js-client/enums/{internal.CartType.md => internal-3.CartType.md} (63%) rename www/apps/docs/content/references/js-client/enums/{internal.ClaimFulfillmentStatus.md => internal-3.ClaimFulfillmentStatus.md} (64%) rename www/apps/docs/content/references/js-client/enums/{internal.ClaimPaymentStatus.md => internal-3.ClaimPaymentStatus.md} (60%) rename www/apps/docs/content/references/js-client/enums/{internal.ClaimReason.md => internal-3.ClaimReason.md} (64%) rename www/apps/docs/content/references/js-client/enums/{internal.ClaimType.md => internal-3.ClaimType.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.DiscountConditionOperator.md => internal-3.DiscountConditionOperator.md} (56%) rename www/apps/docs/content/references/js-client/enums/{internal.DiscountConditionType.md => internal-3.DiscountConditionType.md} (62%) rename www/apps/docs/content/references/js-client/enums/{internal.DiscountRuleType.md => internal-3.DiscountRuleType.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.DraftOrderStatus.md => internal-3.DraftOrderStatus.md} (60%) rename www/apps/docs/content/references/js-client/enums/{internal.FulfillmentStatus.md => internal-3.FulfillmentStatus.md} (67%) rename www/apps/docs/content/references/js-client/enums/{internal.OrderEditItemChangeType.md => internal-3.OrderEditItemChangeType.md} (60%) rename www/apps/docs/content/references/js-client/enums/{internal.OrderEditStatus.md => internal-3.OrderEditStatus.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.OrderStatus.md => internal-3.OrderStatus.md} (64%) rename www/apps/docs/content/references/js-client/enums/{internal.PaymentCollectionStatus.md => internal-3.PaymentCollectionStatus.md} (60%) rename www/apps/docs/content/references/js-client/enums/{internal.PaymentStatus.md => internal-3.PaymentStatus.md} (65%) rename www/apps/docs/content/references/js-client/enums/{internal.PriceListStatus.md => internal-3.PriceListStatus.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.PriceListType.md => internal-3.PriceListType.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.ProductStatus.md => internal-3.ProductStatus.md} (62%) rename www/apps/docs/content/references/js-client/enums/{internal.RequirementType.md => internal-3.RequirementType.md} (59%) rename www/apps/docs/content/references/js-client/enums/{internal.ReturnStatus.md => internal-3.ReturnStatus.md} (64%) rename www/apps/docs/content/references/js-client/enums/{internal.ShippingOptionPriceType.md => internal-3.ShippingOptionPriceType.md} (61%) rename www/apps/docs/content/references/js-client/enums/{internal.ShippingProfileType.md => internal-3.ShippingProfileType.md} (59%) rename www/apps/docs/content/references/js-client/enums/{internal.SwapFulfillmentStatus.md => internal-3.SwapFulfillmentStatus.md} (66%) rename www/apps/docs/content/references/js-client/enums/{internal.SwapPaymentStatus.md => internal-3.SwapPaymentStatus.md} (66%) create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md create mode 100644 www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md rename www/apps/docs/content/references/js-client/enums/{internal-16.RefundReason.md => internal-8.internal.RefundReason.md} (51%) create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.File.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosBasicCredentials.md => internal-12.AxiosBasicCredentials.md} (57%) rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosDefaults.md => internal-12.AxiosDefaults.md} (63%) create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosInterceptorManager.md => internal-12.AxiosInterceptorManager.md} (79%) create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosProxyConfig.md => internal-12.AxiosProxyConfig.md} (63%) rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosRequestTransformer.md => internal-12.AxiosRequestTransformer.md} (59%) rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosResponse.md => internal-12.AxiosResponse.md} (50%) rename www/apps/docs/content/references/js-client/interfaces/{internal.AxiosResponseTransformer.md => internal-12.AxiosResponseTransformer.md} (59%) rename www/apps/docs/content/references/js-client/interfaces/{internal.Cancel.md => internal-12.Cancel.md} (58%) create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md rename www/apps/docs/content/references/js-client/interfaces/{internal.RetryConfig.md => internal-12.RetryConfig.md} (65%) rename www/apps/docs/content/references/js-client/interfaces/{internal.TransitionalOptions.md => internal-12.TransitionalOptions.md} (63%) create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md create mode 100644 www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.AxiosError.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.AxiosInstance.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.AxiosPromise.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.CancelToken.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.Config.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.HTTPResponse.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md delete mode 100644 www/apps/docs/content/references/js-client/interfaces/internal.RequestOptions.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-13.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-14.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-15.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-16.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-17.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-18.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-19.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-20.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-21.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-22.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-23.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-24.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-25.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-26.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-27.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-28.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-29.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-30.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-31.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-32.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-33.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-34.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-35.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-36.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-37.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-38.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-39.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-40.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-41.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-42.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-43.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-44.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-45.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-46.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-47.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-48.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-49.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-50.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-51.md delete mode 100644 www/apps/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md create mode 100644 www/apps/docs/content/references/js-client/modules/internal-8.internal.md diff --git a/docs-util/packages/scripts/package.json b/docs-util/packages/scripts/package.json index f148e60557..be40691b47 100644 --- a/docs-util/packages/scripts/package.json +++ b/docs-util/packages/scripts/package.json @@ -22,6 +22,7 @@ "typedoc-plugin-markdown": "3.16.0", "typedoc-plugin-markdown-medusa": "*", "typedoc-plugin-merge-modules": "5.1.0", + "typedoc-plugin-missing-exports": "^2.1.0", "typedoc-plugin-modules": "*", "typedoc-plugin-reference-excluder": "1.1.3", "typedoc-plugin-rename-defaults": "^0.6.6", diff --git a/docs-util/packages/typedoc-config/js-client.js b/docs-util/packages/typedoc-config/js-client.js index a797bb020d..4ae642a700 100644 --- a/docs-util/packages/typedoc-config/js-client.js +++ b/docs-util/packages/typedoc-config/js-client.js @@ -20,15 +20,16 @@ module.exports = { "typedoc-plugin-merge-modules", "typedoc-plugin-reference-excluder", "typedoc-plugin-frontmatter", + "typedoc-plugin-modules", ], exclude: [ path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"), - "node_modules/**", - "packages/**/node_modules", + path.join(pathPrefix, "node_modules/**"), + path.join(pathPrefix, "packages/**/node_modules"), ], excludeConstructors: true, frontmatterData: { displayed_sidebar: "jsClientSidebar", }, - pagesPattern: "internal\\.", + internalModule: "internal", } diff --git a/docs-util/packages/typedoc-plugin-frontmatter/package.json b/docs-util/packages/typedoc-plugin-frontmatter/package.json index ab8c7cff16..51b7ab0ed6 100644 --- a/docs-util/packages/typedoc-plugin-frontmatter/package.json +++ b/docs-util/packages/typedoc-plugin-frontmatter/package.json @@ -23,7 +23,6 @@ }, "devDependencies": { "@types/node": "^16.11.10", - "typedoc": "^0.25.1", "typescript": "^4.6" }, "keywords": [ diff --git a/docs-util/packages/typedoc-plugin-modules/src/resolve-references-plugin.ts b/docs-util/packages/typedoc-plugin-modules/src/resolve-references-plugin.ts index 65cd945e4d..1b24c5169b 100644 --- a/docs-util/packages/typedoc-plugin-modules/src/resolve-references-plugin.ts +++ b/docs-util/packages/typedoc-plugin-modules/src/resolve-references-plugin.ts @@ -146,6 +146,14 @@ export function load(app: Application) { } } while (missing.size > 0) + // remove paths from reflection name + internalNs?.children?.forEach((item) => { + if (item.name.indexOf(`"`) === 0) { + item.name = + context.converter.application.options.getValue("internalModule") + } + }) + // All the missing symbols were excluded, so get rid of our namespace. if (internalNs && !internalNs.children?.length) { context.project.removeReflection(internalNs) diff --git a/docs-util/yarn.lock b/docs-util/yarn.lock index 03fee4ef03..4d925bc9af 100644 --- a/docs-util/yarn.lock +++ b/docs-util/yarn.lock @@ -2434,6 +2434,7 @@ __metadata: typedoc-plugin-markdown: 3.16.0 typedoc-plugin-markdown-medusa: "*" typedoc-plugin-merge-modules: 5.1.0 + typedoc-plugin-missing-exports: ^2.1.0 typedoc-plugin-modules: "*" typedoc-plugin-reference-excluder: 1.1.3 typedoc-plugin-rename-defaults: ^0.6.6 @@ -2870,6 +2871,15 @@ __metadata: languageName: node linkType: hard +"typedoc-plugin-missing-exports@npm:^2.1.0": + version: 2.1.0 + resolution: "typedoc-plugin-missing-exports@npm:2.1.0" + peerDependencies: + typedoc: 0.24.x || 0.25.x + checksum: 65ba23913e389b473df770ad4b0e29cb1f90c9a11bc6f554863203618d5db23c5296686d03fb6b37dcad75e902d3f7711b5c6589a513cd0a2494f2440c170690 + languageName: node + linkType: hard + "typedoc-plugin-modules@*, typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules": version: 0.0.0-use.local resolution: "typedoc-plugin-modules@workspace:packages/typedoc-plugin-modules" diff --git a/packages/medusa/src/interfaces/payment-service.ts b/packages/medusa/src/interfaces/payment-service.ts index c6a01dec39..8aa27d0903 100644 --- a/packages/medusa/src/interfaces/payment-service.ts +++ b/packages/medusa/src/interfaces/payment-service.ts @@ -65,7 +65,7 @@ export interface PaymentService extends TransactionBaseService { createPayment(context: Cart & PaymentContext): Promise /** - * This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use createPayment(context: `Cart & PaymentContext): Promise` instead * @param cart */ createPayment(cart: Cart): Promise @@ -183,7 +183,7 @@ export abstract class AbstractPaymentService ): Promise /** - * This will be @deprecated in the near future use createPayment(context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use `createPayment(context: Cart & PaymentContext): Promise` instead * @param cart */ public abstract createPayment(cart: Cart): Promise @@ -205,7 +205,7 @@ export abstract class AbstractPaymentService ): Promise /** - * This will be @deprecated in the near future use updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise instead + * This will be @deprecated in the near future use `updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise` instead * @param paymentSessionData * @param cart */ diff --git a/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx b/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx index cde8aafa87..a8d4356208 100644 --- a/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx +++ b/www/apps/docs/content/modules/discounts/admin/manage-discounts.mdx @@ -191,9 +191,9 @@ This request accepts [many request-body parameters](https://docs.medusajs.com/ap - `code`: This parameter is required. It is a unique code. The customer redeems the discount using this code. - `rule`: This parameter is required. It is an object having at least the following fields: - - `type`: A string indicating the type of discount. It can be `fixed`, `percentage`, or `free_shipping`. When using the Medusa JS Client, you must use the enum type [DiscountRuleType](../../../references/js-client/enums/internal.discountruletype/) for the value. + - `type`: A string indicating the type of discount. It can be `fixed`, `percentage`, or `free_shipping`. When using the Medusa JS Client, you must use the enum type [DiscountRuleType](../../../references/js-client/enums/internal-3.DiscountRuleType.md) for the value. - `value`: A number indicating the value of the discount. If the discount type is `fixed`, then it will be the fixed amount to discount from the cart’s totals or its items. If the discount type is `percentage`, then it will be the percentage to discount from the items in the cart. If the type is `free_shipping`, it has no effect and can be set to `0`. - - `allocation`: A string indicating how the discount should be applied. Can be `item` or `total`. If the type is not `fixed`, then this has no effect. When using the Medusa JS Client, you must use the enum type [AllocationType](../../../references/js-client/enums/internal.allocationtype/) for the value. + - `allocation`: A string indicating how the discount should be applied. Can be `item` or `total`. If the type is not `fixed`, then this has no effect. When using the Medusa JS Client, you must use the enum type [AllocationType](../../../references/js-client/enums/internal-3.AllocationType.md) for the value. - `regions`: An array of region IDs this discount can be used in. If the type of discount is `fixed`, only one region can be passed. This request returns the full `discount` object. diff --git a/www/apps/docs/content/references/js-client/classes/AddressesResource.md b/www/apps/docs/content/references/js-client/classes/AddressesResource.md index 2467e78c34..b9d1ca3092 100644 --- a/www/apps/docs/content/references/js-client/classes/AddressesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AddressesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AddressesResource ## Hierarchy @@ -10,7 +14,7 @@ ### addAddress -▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Adds an address to a customers saved addresses @@ -19,21 +23,21 @@ Adds an address to a customers saved addresses | Name | Type | Description | | :------ | :------ | :------ | | `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L16) +[packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L16) ___ ### deleteAddress -▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Deletes an address of a customer @@ -42,21 +46,21 @@ Deletes an address of a customer | Name | Type | Description | | :------ | :------ | :------ | | `address_id` | `string` | id of the address to delete | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L30) +[packages/medusa-js/src/resources/addresses.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L30) ___ ### updateAddress -▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Update an address of a customer @@ -66,12 +70,12 @@ Update an address of a customer | :------ | :------ | :------ | | `address_id` | `string` | id of customer | | `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/addresses.ts#L45) +[packages/medusa-js/src/resources/addresses.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/addresses.ts#L45) diff --git a/www/apps/docs/content/references/js-client/classes/Admin.md b/www/apps/docs/content/references/js-client/classes/Admin.md index e579544731..a41c33ad1f 100644 --- a/www/apps/docs/content/references/js-client/classes/Admin.md +++ b/www/apps/docs/content/references/js-client/classes/Admin.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: Admin ## Hierarchy @@ -14,7 +18,7 @@ #### Defined in -[medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L37) +[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L42) ___ @@ -24,7 +28,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L38) +[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L43) ___ @@ -34,7 +38,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L43) +[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L48) ___ @@ -44,7 +48,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L42) +[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L47) + +___ + +### custom + +• **custom**: [`AdminCustomResource`](AdminCustomResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L79) ___ @@ -54,7 +68,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L40) +[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L45) ___ @@ -64,7 +78,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L39) +[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L44) ___ @@ -74,7 +88,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L41) +[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L46) ___ @@ -84,7 +98,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L44) +[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L49) ___ @@ -94,7 +108,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L45) +[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L50) + +___ + +### inventoryItems + +• **inventoryItems**: [`AdminInventoryItemsResource`](AdminInventoryItemsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L52) ___ @@ -104,7 +128,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L46) +[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L51) ___ @@ -114,7 +138,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L47) +[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L53) ___ @@ -124,7 +148,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L65) +[packages/medusa-js/src/resources/admin/index.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L73) ___ @@ -134,7 +158,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L55) +[packages/medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L61) ___ @@ -144,7 +168,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L54) +[packages/medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L60) ___ @@ -154,7 +178,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L68) +[packages/medusa-js/src/resources/admin/index.ts:76](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L76) ___ @@ -164,7 +188,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L69) +[packages/medusa-js/src/resources/admin/index.ts:77](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L77) ___ @@ -174,7 +198,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L48) +[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L54) + +___ + +### productCategories + +• **productCategories**: [`AdminProductCategoriesResource`](AdminProductCategoriesResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L78) ___ @@ -184,7 +218,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L50) +[packages/medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L56) ___ @@ -194,7 +228,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L51) +[packages/medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L57) ___ @@ -204,7 +238,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L49) +[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L55) ___ @@ -214,7 +248,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L56) +[packages/medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L62) ___ @@ -224,7 +258,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L64) +[packages/medusa-js/src/resources/admin/index.ts:71](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L71) + +___ + +### reservations + +• **reservations**: [`AdminReservationsResource`](AdminReservationsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L72) ___ @@ -234,7 +278,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L57) +[packages/medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L63) ___ @@ -244,7 +288,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L53) +[packages/medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L59) ___ @@ -254,7 +298,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L59) +[packages/medusa-js/src/resources/admin/index.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L65) ___ @@ -264,7 +308,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L63) +[packages/medusa-js/src/resources/admin/index.ts:70](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L70) ___ @@ -274,7 +318,17 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:61](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L61) +[packages/medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L67) + +___ + +### stockLocations + +• **stockLocations**: [`AdminStockLocationsResource`](AdminStockLocationsResource.md) + +#### Defined in + +[packages/medusa-js/src/resources/admin/index.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L68) ___ @@ -284,7 +338,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L62) +[packages/medusa-js/src/resources/admin/index.ts:69](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L69) ___ @@ -294,7 +348,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:60](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L60) +[packages/medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L66) ___ @@ -304,7 +358,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L66) +[packages/medusa-js/src/resources/admin/index.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L74) ___ @@ -314,7 +368,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:67](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L67) +[packages/medusa-js/src/resources/admin/index.ts:75](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L75) ___ @@ -324,7 +378,7 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L52) +[packages/medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L58) ___ @@ -334,4 +388,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/index.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/index.ts#L58) +[packages/medusa-js/src/resources/admin/index.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/index.ts#L64) diff --git a/www/apps/docs/content/references/js-client/classes/AdminAuthResource.md b/www/apps/docs/content/references/js-client/classes/AdminAuthResource.md index 70abc23301..dbabb43408 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminAuthResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminAuthResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminAuthResource ## Hierarchy @@ -10,72 +14,97 @@ ### createSession -▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> - -**`Description`** - -Creates an authenticated session +▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> #### Parameters | Name | Type | | :------ | :------ | | `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> + +**`Description`** + +Creates an authenticated session #### Defined in -[medusa-js/src/resources/admin/auth.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L37) +[packages/medusa-js/src/resources/admin/auth.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L38) ___ ### deleteSession -▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> - -**`Description`** - -destroys an authenticated session +▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> + +**`Description`** + +destroys an authenticated session #### Defined in -[medusa-js/src/resources/admin/auth.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L24) +[packages/medusa-js/src/resources/admin/auth.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L25) ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> **`Description`** Retrieves an authenticated session Usually used to check if authenticated session is alive. +#### Defined in + +[packages/medusa-js/src/resources/admin/auth.ts:13](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L13) + +___ + +### getToken + +▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBearerAuthRes`](../modules/internal-1.md#adminbearerauthres)\> + #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostAuthReq`](internal-1.AdminPostAuthReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal-1.md#adminauthres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBearerAuthRes`](../modules/internal-1.md#adminbearerauthres)\> + +**`Description`** + +Retrieves a new JWT access token #### Defined in -[medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/auth.ts#L12) +[packages/medusa-js/src/resources/admin/auth.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/auth.ts#L52) diff --git a/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md b/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md index 27b9370a7d..adc00c6d33 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminBatchJobsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminBatchJobsResource ## Hierarchy @@ -10,103 +14,103 @@ ### cancel -▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Parameters | Name | Type | | :------ | :------ | | `batchJobId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35) +[packages/medusa-js/src/resources/admin/batch-jobs.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L35) ___ ### confirm -▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Parameters | Name | Type | | :------ | :------ | | `batchJobId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43) +[packages/medusa-js/src/resources/admin/batch-jobs.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L43) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Parameters | Name | Type | | :------ | :------ | | `payload` | [`AdminPostBatchesReq`](internal-2.AdminPostBatchesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13) +[packages/medusa-js/src/resources/admin/batch-jobs.ts:13](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L13) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> #### Parameters | Name | Type | | :------ | :------ | | `query?` | [`AdminGetBatchParams`](internal-2.AdminGetBatchParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobListRes`](../modules/internal-2.md#adminbatchjoblistres)\> #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21) +[packages/medusa-js/src/resources/admin/batch-jobs.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L21) ___ ### retrieve -▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Parameters | Name | Type | | :------ | :------ | | `batchJobId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminBatchJobRes`](../modules/internal-2.md#adminbatchjobres)\> #### Defined in -[medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51) +[packages/medusa-js/src/resources/admin/batch-jobs.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/batch-jobs.ts#L51) diff --git a/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md b/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md index efd936b0eb..6d9dd8ff71 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminCollectionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminCollectionsResource ## Hierarchy @@ -10,11 +14,7 @@ ### addProducts -▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -**`Description`** - -Updates products associated with a Product Collection +▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> #### Parameters @@ -22,106 +22,106 @@ Updates products associated with a Product Collection | :------ | :------ | :------ | | `id` | `string` | the id of the Collection | | `payload` | [`AdminPostProductsToCollectionReq`](internal-3.AdminPostProductsToCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> + +**`Description`** + +Updates products associated with a Product Collection #### Defined in -[medusa-js/src/resources/admin/collections.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L100) +[packages/medusa-js/src/resources/admin/collections.ts:101](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L101) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -**`Description`** - -Creates a collection. +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> Created collection. +**`Description`** + +Creates a collection. + #### Defined in -[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L22) +[packages/medusa-js/src/resources/admin/collections.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L23) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -deletes a collection +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of collection to delete. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> Deleted response +**`Description`** + +deletes a collection + #### Defined in -[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L52) +[packages/medusa-js/src/resources/admin/collections.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L53) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> - -**`Description`** - -Lists collections matching a query +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\> a list of collections matching the query. +**`Description`** + +Lists collections matching a query + #### Defined in -[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L80) +[packages/medusa-js/src/resources/admin/collections.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L81) ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -Removes products associated with a Product Collection +▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\> #### Parameters @@ -129,52 +129,52 @@ Removes products associated with a Product Collection | :------ | :------ | :------ | | `id` | `string` | the id of the Collection | | `payload` | [`AdminDeleteProductsFromCollectionReq`](internal-3.AdminDeleteProductsFromCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\> + +**`Description`** + +Removes products associated with a Product Collection #### Defined in -[medusa-js/src/resources/admin/collections.ts:115](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L115) +[packages/medusa-js/src/resources/admin/collections.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L116) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -**`Description`** - -get a collection +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the collection to retrieve. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> the collection with the given id +**`Description`** + +get a collection + #### Defined in -[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L66) +[packages/medusa-js/src/resources/admin/collections.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L67) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> - -**`Description`** - -Updates a collection +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> #### Parameters @@ -182,14 +182,18 @@ Updates a collection | :------ | :------ | :------ | | `id` | `string` | id of the collection to update. | | `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\> the updated collection. +**`Description`** + +Updates a collection + #### Defined in -[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L37) +[packages/medusa-js/src/resources/admin/collections.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L38) diff --git a/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md b/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md index a299e4305d..69d29dc8e8 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminCurrenciesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminCurrenciesResource ## Hierarchy @@ -10,7 +14,20 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> + +the list of currencies as well as the pagination properties. **`Description`** @@ -18,34 +35,15 @@ Lists currencies. This feature is under development and may change in the future. To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesListRes`](../modules/internal-4.md#admincurrencieslistres)\> - -the list of currencies as well as the pagination properties. - #### Defined in -[medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/currencies.ts#L20) +[packages/medusa-js/src/resources/admin/currencies.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/currencies.ts#L20) ___ ### update -▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> - -**`Description`** - -Updates a currency - This feature is under development and may change in the future. -To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. +▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> #### Parameters @@ -53,14 +51,20 @@ To use this feature please enable featureflag `tax_inclusive_pricing` in your me | :------ | :------ | :------ | | `code` | `string` | code of the currency to update. | | `payload` | [`AdminPostCurrenciesCurrencyReq`](internal-4.AdminPostCurrenciesCurrencyReq.md) | update to apply to currency. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCurrenciesRes`](../modules/internal-4.md#admincurrenciesres)\> the updated currency. +**`Description`** + +Updates a currency + This feature is under development and may change in the future. +To use this feature please enable featureflag `tax_inclusive_pricing` in your medusa backend project. + #### Defined in -[medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/currencies.ts#L43) +[packages/medusa-js/src/resources/admin/currencies.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/currencies.ts#L43) diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomResource.md b/www/apps/docs/content/references/js-client/classes/AdminCustomResource.md new file mode 100644 index 0000000000..dac8453265 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomResource.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminCustomResource + +## Hierarchy + +- `default` + + ↳ **`AdminCustomResource`** + +## Methods + +### delete + +▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TResponse` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | +| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/custom.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L47) + +___ + +### get + +▸ **get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TQuery` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> | +| `TResponse` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `query?` | `TQuery` | +| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | +| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/custom.ts:8](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L8) + +___ + +### post + +▸ **post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TPayload` | extends [`Record`](../modules/internal.md#record)<`string`, `any`\> | +| `TResponse` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `payload?` | `TPayload` | +| `options?` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | +| `customHeaders?` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`TResponse`\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/custom.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/custom.ts#L30) diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md index ffba8570e7..1f08663f63 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomerGroupsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminCustomerGroupsResource ## Hierarchy @@ -10,7 +14,7 @@ ### addCustomers -▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> Add multiple customers to a customer group. @@ -19,22 +23,22 @@ Add multiple customers to a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) +[packages/medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L112) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> Create a customer group. @@ -42,22 +46,22 @@ Create a customer group. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostCustomerGroupsReq`](internal-5.AdminPostCustomerGroupsReq.md) | customer group info | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostCustomerGroupsReq`](internal-6.AdminPostCustomerGroupsReq.md) | customer group info | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) +[packages/medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L26) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> Deletes a customer group. @@ -66,21 +70,21 @@ Deletes a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the customer group | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) +[packages/medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L77) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\> Lists customer groups. @@ -88,22 +92,22 @@ Lists customer groups. | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) | optional | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) | optional | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-5.md#admincustomergroupslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal-6.md#admincustomergroupslistres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) +[packages/medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L91) ___ ### listCustomers -▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> +▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> List and count customers that belong to provided customer groups. @@ -112,22 +116,22 @@ List and count customers that belong to provided customer groups. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | params for filtering customers | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | params for filtering customers | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) +[packages/medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L144) ___ ### removeCustomers -▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> Remove multiple customers from a customer group. @@ -136,22 +140,22 @@ Remove multiple customers from a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) +[packages/medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L128) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> Retrieves a customer group. @@ -160,22 +164,22 @@ Retrieves a customer group. | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal-6.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) +[packages/medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L41) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> Updates a customer group @@ -184,13 +188,13 @@ Updates a customer group | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer group id | -| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-5.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal-6.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-5.md#admincustomergroupsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal-6.md#admincustomergroupsres)\> #### Defined in -[medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) +[packages/medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customer-groups.ts#L62) diff --git a/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md b/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md index 7d213e1b3c..660a185194 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminCustomersResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminCustomersResource ## Hierarchy @@ -10,7 +14,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> Creates a customer @@ -18,22 +22,22 @@ Creates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostCustomersReq`](internal-6.AdminPostCustomersReq.md) | information of customer | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostCustomersReq`](internal-7.AdminPostCustomersReq.md) | information of customer | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L18) +[packages/medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L18) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> Lists customers @@ -41,22 +45,22 @@ Lists customers | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) | optional | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) | optional | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-5.md#admincustomerslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal-7.md#admincustomerslistres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L59) +[packages/medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L59) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> Retrieves a customer @@ -65,21 +69,21 @@ Retrieves a customer | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer id | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L46) +[packages/medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L46) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> Updates a customer @@ -88,13 +92,13 @@ Updates a customer | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | customer id | -| `payload` | [`AdminPostCustomersCustomerReq`](internal-6.AdminPostCustomersCustomerReq.md) | data to update customer with | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostCustomersCustomerReq`](internal-7.AdminPostCustomersCustomerReq.md) | data to update customer with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-6.md#admincustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCustomersRes`](../modules/internal-7.md#admincustomersres)\> #### Defined in -[medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/customers.ts#L32) +[packages/medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/customers.ts#L32) diff --git a/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md b/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md index 9d65bb54ab..1657ff6a41 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminDiscountsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminDiscountsResource ## Hierarchy @@ -10,194 +14,190 @@ ### addConditionResourceBatch -▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `conditionId` | `string` | +| `payload` | [`AdminPostDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) | +| `query?` | [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> **`Description`** Add a batch of items to a discount condition -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `conditionId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditionsConditionBatchReq`](internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) | -| `query?` | [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L218) +[packages/medusa-js/src/resources/admin/discounts.ts:218](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L218) ___ ### addRegion -▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `regionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> **`Description`** Adds region to discount -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `regionId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L27) +[packages/medusa-js/src/resources/admin/discounts.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L27) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostDiscountsReq`](internal-8.AdminPostDiscountsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> **`Description`** Creates discounts -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostDiscountsReq`](internal-7.AdminPostDiscountsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L39) +[packages/medusa-js/src/resources/admin/discounts.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L39) ___ ### createCondition -▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-8.AdminPostDiscountsDiscountConditions.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-8.AdminPostDiscountsDiscountConditionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> **`Description`** creates a discount condition -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditions`](internal-7.AdminPostDiscountsDiscountConditions.md) | -| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal-7.AdminPostDiscountsDiscountConditionsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L148) +[packages/medusa-js/src/resources/admin/discounts.ts:148](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L148) ___ ### createDynamicCode -▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> **`Description`** Creates a dynamic discount code -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L62) +[packages/medusa-js/src/resources/admin/discounts.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L62) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -Deletes a discount +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +**`Description`** + +Deletes a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L74) +[packages/medusa-js/src/resources/admin/discounts.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L74) ___ ### deleteCondition -▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `conditionId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> **`Description`** Removes a condition from a discount -#### Parameters - -| Name | Type | -| :------ | :------ | -| `discountId` | `string` | -| `conditionId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - #### Defined in -[medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L187) +[packages/medusa-js/src/resources/admin/discounts.ts:187](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L187) ___ ### deleteConditionResourceBatch -▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Delete a batch of items from a discount condition +▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters @@ -205,26 +205,26 @@ Delete a batch of items from a discount condition | :------ | :------ | | `discountId` | `string` | | `conditionId` | `string` | -| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteDiscountsDiscountConditionsConditionBatchReq`](internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Delete a batch of items from a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:238](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L238) +[packages/medusa-js/src/resources/admin/discounts.ts:238](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L238) ___ ### deleteDynamicCode -▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Deletes a dynamic discount +▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters @@ -232,25 +232,25 @@ Deletes a dynamic discount | :------ | :------ | | `id` | `string` | | `code` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Deletes a dynamic discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L85) +[packages/medusa-js/src/resources/admin/discounts.ts:85](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L85) ___ ### getCondition -▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> - -**`Description`** - -Gets a condition from a discount +▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\> #### Parameters @@ -258,51 +258,51 @@ Gets a condition from a discount | :------ | :------ | | `discountId` | `string` | | `conditionId` | `string` | -| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-7.md#admindiscountconditionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal-8.md#admindiscountconditionsres)\> + +**`Description`** + +Gets a condition from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L199) +[packages/medusa-js/src/resources/admin/discounts.ts:199](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L199) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> - -**`Description`** - -Lists discounts +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetDiscountsParams`](internal-7.AdminGetDiscountsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetDiscountsParams`](internal-8.AdminGetDiscountsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-7.md#admindiscountslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal-8.md#admindiscountslistres)\> + +**`Description`** + +Lists discounts #### Defined in -[medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L119) +[packages/medusa-js/src/resources/admin/discounts.ts:119](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L119) ___ ### removeRegion -▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Removes a region from a discount +▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters @@ -310,101 +310,101 @@ Removes a region from a discount | :------ | :------ | | `id` | `string` | | `regionId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Removes a region from a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L136) +[packages/medusa-js/src/resources/admin/discounts.ts:136](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L136) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Retrieves a discount +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Retrieves a discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L97) +[packages/medusa-js/src/resources/admin/discounts.ts:97](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L97) ___ ### retrieveByCode -▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Retrieves a discount by code +▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters | Name | Type | | :------ | :------ | | `code` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Retrieves a discount by code #### Defined in -[medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L108) +[packages/medusa-js/src/resources/admin/discounts.ts:108](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L108) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Updates discount +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDiscountsDiscountReq`](internal-7.AdminPostDiscountsDiscountReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostDiscountsDiscountReq`](internal-8.AdminPostDiscountsDiscountReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Updates discount #### Defined in -[medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L50) +[packages/medusa-js/src/resources/admin/discounts.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L50) ___ ### updateCondition -▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> - -**`Description`** - -Updates a discount condition +▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> #### Parameters @@ -412,14 +412,18 @@ Updates a discount condition | :------ | :------ | | `discountId` | `string` | | `conditionId` | `string` | -| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) | -| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) | +| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-7.md#admindiscountsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal-8.md#admindiscountsres)\> + +**`Description`** + +Updates a discount condition #### Defined in -[medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/discounts.ts#L167) +[packages/medusa-js/src/resources/admin/discounts.ts:167](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/discounts.ts#L167) diff --git a/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md b/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md index 6ef53273f7..de3f9cf731 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminDraftOrdersResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminDraftOrdersResource ## Hierarchy @@ -10,214 +14,210 @@ ### addLineItem -▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> **`Description`** Add line item to draft order -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) +[packages/medusa-js/src/resources/admin/draft-orders.ts:30](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L30) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostDraftOrdersReq`](internal-8.internal.AdminPostDraftOrdersReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> **`Description`** Creates a draft order -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostDraftOrdersReq`](internal-8.AdminPostDraftOrdersReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L20) +[packages/medusa-js/src/resources/admin/draft-orders.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L20) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> **`Description`** Delete draft order -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) +[packages/medusa-js/src/resources/admin/draft-orders.ts:42](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L42) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.internal.md#admindraftorderslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetDraftOrdersParams`](internal-8.internal.AdminGetDraftOrdersParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.internal.md#admindraftorderslistres)\> **`Description`** Lists draft orders -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetDraftOrdersParams`](internal-8.AdminGetDraftOrdersParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal-8.md#admindraftorderslistres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) +[packages/medusa-js/src/resources/admin/draft-orders.ts:76](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L76) ___ ### markPaid -▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\> +▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.internal.md#adminpostdraftordersdraftorderregisterpaymentres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.internal.md#adminpostdraftordersdraftorderregisterpaymentres)\> **`Description`** Mark a draft order as paid -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal-8.md#adminpostdraftordersdraftorderregisterpaymentres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) +[packages/medusa-js/src/resources/admin/draft-orders.ts:93](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L93) ___ ### removeLineItem -▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `itemId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> **`Description`** Remove line item -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `itemId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) +[packages/medusa-js/src/resources/admin/draft-orders.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L53) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> **`Description`** Retrieves a draft order -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) +[packages/medusa-js/src/resources/admin/draft-orders.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L65) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - -**`Description`** - -Update draft order +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.AdminPostDraftOrdersDraftOrderReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +**`Description`** + +Update draft order #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) +[packages/medusa-js/src/resources/admin/draft-orders.ts:104](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L104) ___ ### updateLineItem -▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> - -**`Description`** - -Update draft order line item +▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> #### Parameters @@ -225,13 +225,17 @@ Update draft order line item | :------ | :------ | | `id` | `string` | | `itemId` | `string` | -| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.md#admindraftordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal-8.internal.md#admindraftordersres)\> + +**`Description`** + +Update draft order line item #### Defined in -[medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/draft-orders.ts#L116) +[packages/medusa-js/src/resources/admin/draft-orders.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/draft-orders.ts#L116) diff --git a/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md b/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md index 860234cee7..a4783beed4 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminGiftCardsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGiftCardsResource ## Hierarchy @@ -10,124 +14,124 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostGiftCardsReq`](internal-8.internal.AdminPostGiftCardsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> **`Description`** Creates a gift card -#### Parameters - -| Name | Type | -| :------ | :------ | -| `payload` | [`AdminPostGiftCardsReq`](internal-9.AdminPostGiftCardsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> - #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) +[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L17) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -Deletes a gift card +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +**`Description`** + +Deletes a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) +[packages/medusa-js/src/resources/admin/gift-cards.ts:40](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L40) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetGiftCardsParams`](internal-8.internal.AdminGetGiftCardsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-8.internal.md#admingiftcardslistres)\> **`Description`** Lists gift cards -#### Parameters - -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetGiftCardsParams`](internal-9.AdminGetGiftCardsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal-9.md#admingiftcardslistres)\> - #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) +[packages/medusa-js/src/resources/admin/gift-cards.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L62) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> **`Description`** Deletes a gift card -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> - #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) +[packages/medusa-js/src/resources/admin/gift-cards.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L51) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> - -**`Description`** - -Updates a gift card +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-9.AdminPostGiftCardsGiftCardReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal-8.internal.AdminPostGiftCardsGiftCardReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-9.md#admingiftcardsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal-8.internal.md#admingiftcardsres)\> + +**`Description`** + +Updates a gift card #### Defined in -[medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/gift-cards.ts#L28) +[packages/medusa-js/src/resources/admin/gift-cards.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/gift-cards.ts#L28) diff --git a/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md b/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md new file mode 100644 index 0000000000..816e7b240e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/AdminInventoryItemsResource.md @@ -0,0 +1,302 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminInventoryItemsResource + +## Hierarchy + +- `default` + + ↳ **`AdminInventoryItemsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Create an Inventory Item + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostInventoryItemsReq`](internal-8.internal.AdminPostInventoryItemsReq.md) | +| `query?` | [`AdminPostInventoryItemsParams`](internal-8.internal.AdminPostInventoryItemsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +the created Inventory Item + +**`Description`** + +creates an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L88) + +___ + +### createLocationLevel + +▸ **createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Create stock for an Inventory Item at a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `payload` | [`AdminPostInventoryItemsItemLocationLevelsReq`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md) | +| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +the Inventory Item + +**`Description`** + +creates stock levle for an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:155](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L155) + +___ + +### delete + +▸ **delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +Delete an Inventory Item + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +the deleted Inventory Item + +**`Description`** + +deletes an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L73) + +___ + +### deleteLocationLevel + +▸ **deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Removes an Inventory Item from a Stock Location. This erases trace of any quantity currently at the location. + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationId` | `string` | +| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +the Inventory Item + +**`Description`** + +deletes a location level of an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:178](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L178) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslistwithvariantsandlocationlevelsres)\> + +Retrieve a list of Inventory Items + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslistwithvariantsandlocationlevelsres)\> + +the list of Inventory Items as well as the pagination properties + +**`Description`** + +Retrieve a list of Inventory Items + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:110](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L110) + +___ + +### listLocationLevels + +▸ **listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslocationlevelsres)\> + +Retrieve a list of Inventory Levels related to an Inventory Item across Stock Locations + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `query?` | [`AdminGetInventoryItemsItemLocationLevelsParams`](internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../modules/internal-8.internal.md#admininventoryitemslocationlevelsres)\> + +the list of inventory levels related to an Inventory Item as well as the pagination properties + +**`Description`** + +Retrieve a list of location levels related to an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:201](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L201) + +___ + +### retrieve + +▸ **retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Retrieve an Inventory Item + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `query?` | [`AdminGetInventoryItemsItemParams`](internal-8.internal.AdminGetInventoryItemsItemParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +an Inventory Item + +**`Description`** + +gets an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L28) + +___ + +### update + +▸ **update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Update an Inventory Item + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `payload` | [`AdminPostInventoryItemsInventoryItemReq`](internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md) | +| `query?` | [`AdminGetInventoryItemsItemParams`](internal-8.internal.AdminGetInventoryItemsItemParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +the updated Inventory Item + +**`Description`** + +updates an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L50) + +___ + +### updateLocationLevel + +▸ **updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +Update an Inventory Item's stock level at a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationId` | `string` | +| `payload` | [`AdminPostInventoryItemsItemLocationLevelsLevelReq`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md) | +| `query?` | [`AdminGetInventoryItemsParams`](internal-8.internal.AdminGetInventoryItemsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminInventoryItemsRes`](../modules/internal-8.internal.md#admininventoryitemsres)\> + +the updated Inventory Item + +**`Description`** + +updates an Inventory Item + +#### Defined in + +[packages/medusa-js/src/resources/admin/inventory-item.ts:131](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/inventory-item.ts#L131) diff --git a/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md b/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md index 3bfc25028c..8b2da86ec4 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminInvitesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminInvitesResource ## Hierarchy @@ -10,102 +14,102 @@ ### accept -▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-10.AdminPostInvitesInviteAcceptReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal-8.internal.AdminPostInvitesInviteAcceptReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Defined in -[medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L10) +[packages/medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L10) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostInvitesPayload`](../modules/internal-10.md#adminpostinvitespayload) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostInvitesPayload`](../modules/internal-9.md#adminpostinvitespayload) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Defined in -[medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L18) +[packages/medusa-js/src/resources/admin/invites.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L18) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L26) +[packages/medusa-js/src/resources/admin/invites.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L26) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-10.md#adminlistinvitesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal-8.internal.md#adminlistinvitesres)\> #### Defined in -[medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L34) +[packages/medusa-js/src/resources/admin/invites.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L34) ___ ### resend -▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Defined in -[medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/invites.ts#L41) +[packages/medusa-js/src/resources/admin/invites.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/invites.ts#L41) diff --git a/www/apps/docs/content/references/js-client/classes/AdminNotesResource.md b/www/apps/docs/content/references/js-client/classes/AdminNotesResource.md index 03d23fd852..b53a360cac 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminNotesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminNotesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminNotesResource ## Hierarchy @@ -10,104 +14,104 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostNotesReq`](internal-11.AdminPostNotesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostNotesReq`](internal-8.internal.AdminPostNotesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L14) +[packages/medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L14) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L31) +[packages/medusa-js/src/resources/admin/notes.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L31) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetNotesParams`](internal-11.AdminGetNotesParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetNotesParams`](internal-8.internal.AdminGetNotesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-11.md#adminnoteslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesListRes`](../modules/internal-8.internal.md#adminnoteslistres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L47) +[packages/medusa-js/src/resources/admin/notes.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L47) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L39) +[packages/medusa-js/src/resources/admin/notes.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L39) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostNotesNoteReq`](internal-11.AdminPostNotesNoteReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostNotesNoteReq`](internal-8.internal.AdminPostNotesNoteReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal-11.md#adminnotesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotesRes`](../modules/internal-8.internal.md#adminnotesres)\> #### Defined in -[medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notes.ts#L22) +[packages/medusa-js/src/resources/admin/notes.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notes.ts#L22) diff --git a/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md b/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md index be6690a33b..effb8468bf 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminNotificationsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminNotificationsResource ## Hierarchy @@ -10,41 +14,41 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetNotificationsParams`](internal-12.AdminGetNotificationsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetNotificationsParams`](internal-8.internal.AdminGetNotificationsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-12.md#adminnotificationslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal-8.internal.md#adminnotificationslistres)\> #### Defined in -[medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notifications.ts#L12) +[packages/medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notifications.ts#L12) ___ ### resend -▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> +▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-12.AdminPostNotificationsNotificationResendReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal-8.internal.AdminPostNotificationsNotificationResendReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-12.md#adminnotificationsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal-8.internal.md#adminnotificationsres)\> #### Defined in -[medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/notifications.ts#L26) +[packages/medusa-js/src/resources/admin/notifications.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/notifications.ts#L26) diff --git a/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md b/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md index 6e1b2ad71b..502a6290c9 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminOrderEditsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminOrderEditsResource ## Hierarchy @@ -10,113 +14,113 @@ ### addLineItem -▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-13.AdminPostOrderEditsEditLineItemsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrderEditsEditLineItemsReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L72) +[packages/medusa-js/src/resources/admin/order-edits.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L72) ___ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L98) +[packages/medusa-js/src/resources/admin/order-edits.ts:98](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L98) ___ ### confirm -▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L106) +[packages/medusa-js/src/resources/admin/order-edits.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L106) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostOrderEditsReq`](internal-13.AdminPostOrderEditsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrderEditsReq`](internal-8.internal.AdminPostOrderEditsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L47) +[packages/medusa-js/src/resources/admin/order-edits.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L47) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L64) +[packages/medusa-js/src/resources/admin/order-edits.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L64) ___ ### deleteItemChange -▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\> #### Parameters @@ -124,42 +128,42 @@ ___ | :------ | :------ | | `orderEditId` | `string` | | `itemChangeId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-13.md#adminorderedititemchangedeleteres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../modules/internal-8.internal.md#adminorderedititemchangedeleteres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L81) +[packages/medusa-js/src/resources/admin/order-edits.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L81) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-13.md#adminordereditslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`GetOrderEditsParams`](internal-13.GetOrderEditsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`GetOrderEditsParams`](internal-8.internal.GetOrderEditsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-13.md#adminordereditslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsListRes`](../modules/internal-8.internal.md#adminordereditslistres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L33) +[packages/medusa-js/src/resources/admin/order-edits.ts:33](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L33) ___ ### removeLineItem -▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters @@ -167,86 +171,86 @@ ___ | :------ | :------ | | `orderEditId` | `string` | | `itemId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L124) +[packages/medusa-js/src/resources/admin/order-edits.ts:124](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L124) ___ ### requestConfirmation -▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L90) +[packages/medusa-js/src/resources/admin/order-edits.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L90) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`GetOrderEditsOrderEditParams`](internal-13.GetOrderEditsOrderEditParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`GetOrderEditsOrderEditParams`](internal-8.internal.GetOrderEditsOrderEditParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L18) +[packages/medusa-js/src/resources/admin/order-edits.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L18) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-13.AdminPostOrderEditsOrderEditReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrderEditsOrderEditReq`](internal-8.internal.AdminPostOrderEditsOrderEditReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L55) +[packages/medusa-js/src/resources/admin/order-edits.ts:55](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L55) ___ ### updateLineItem -▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Parameters @@ -254,13 +258,13 @@ ___ | :------ | :------ | | `orderEditId` | `string` | | `itemId` | `string` | -| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrderEditsEditLineItemsLineItemReq`](internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-13.md#adminordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrderEditsRes`](../modules/internal-8.internal.md#adminordereditsres)\> #### Defined in -[medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/order-edits.ts#L114) +[packages/medusa-js/src/resources/admin/order-edits.ts:114](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/order-edits.ts#L114) diff --git a/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md b/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md index e7be102637..abfec3267e 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminOrdersResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminOrdersResource ## Hierarchy @@ -10,71 +14,71 @@ ### addShippingMethod -▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-14.AdminPostOrdersOrderShippingMethodsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L152) +[packages/medusa-js/src/resources/admin/orders.ts:152](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L152) ___ ### archive -▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L161) +[packages/medusa-js/src/resources/admin/orders.ts:161](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L161) ___ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L144) +[packages/medusa-js/src/resources/admin/orders.ts:144](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L144) ___ ### cancelClaim -▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -82,21 +86,21 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L225) +[packages/medusa-js/src/resources/admin/orders.ts:225](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L225) ___ ### cancelClaimFulfillment -▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -105,21 +109,21 @@ ___ | `id` | `string` | | `claimId` | `string` | | `fulfillmentId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L116) +[packages/medusa-js/src/resources/admin/orders.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L116) ___ ### cancelFulfillment -▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -127,21 +131,21 @@ ___ | :------ | :------ | | `id` | `string` | | `fulfillmentId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L97) +[packages/medusa-js/src/resources/admin/orders.ts:97](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L97) ___ ### cancelSwap -▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -149,21 +153,21 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L178) +[packages/medusa-js/src/resources/admin/orders.ts:178](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L178) ___ ### cancelSwapFulfillment -▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -172,85 +176,85 @@ ___ | `id` | `string` | | `swapId` | `string` | | `fulfillmentId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L106) +[packages/medusa-js/src/resources/admin/orders.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L106) ___ ### capturePayment -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L71) +[packages/medusa-js/src/resources/admin/orders.ts:71](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L71) ___ ### complete -▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L63) +[packages/medusa-js/src/resources/admin/orders.ts:63](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L63) ___ ### createClaim -▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-14.AdminPostOrdersOrderClaimsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal-8.internal.AdminPostOrdersOrderClaimsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L216) +[packages/medusa-js/src/resources/admin/orders.ts:216](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L216) ___ ### createClaimShipment -▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -258,88 +262,88 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L254) +[packages/medusa-js/src/resources/admin/orders.ts:254](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L254) ___ ### createFulfillment -▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-14.AdminPostOrdersOrderFulfillmentsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L88) +[packages/medusa-js/src/resources/admin/orders.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L88) ___ ### createShipment -▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-14.AdminPostOrdersOrderShipmentReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal-8.internal.AdminPostOrdersOrderShipmentReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L126) +[packages/medusa-js/src/resources/admin/orders.ts:126](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L126) ___ ### createSwap -▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-14.AdminPostOrdersOrderSwapsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal-8.internal.AdminPostOrdersOrderSwapsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L169) +[packages/medusa-js/src/resources/admin/orders.ts:169](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L169) ___ ### createSwapShipment -▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -347,22 +351,22 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L197) +[packages/medusa-js/src/resources/admin/orders.ts:197](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L197) ___ ### fulfillClaim -▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -370,22 +374,22 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L244) +[packages/medusa-js/src/resources/admin/orders.ts:244](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L244) ___ ### fulfillSwap -▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -393,43 +397,43 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L187) +[packages/medusa-js/src/resources/admin/orders.ts:187](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L187) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-14.md#adminorderslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal-8.internal.md#adminorderslistres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L49) +[packages/medusa-js/src/resources/admin/orders.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L49) ___ ### processSwapPayment -▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -437,109 +441,109 @@ ___ | :------ | :------ | | `id` | `string` | | `swapId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L207) +[packages/medusa-js/src/resources/admin/orders.ts:207](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L207) ___ ### refundPayment -▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-14.AdminPostOrdersOrderRefundsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal-8.internal.AdminPostOrdersOrderRefundsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L79) +[packages/medusa-js/src/resources/admin/orders.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L79) ___ ### requestReturn -▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-14.AdminPostOrdersOrderReturnsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal-8.internal.AdminPostOrdersOrderReturnsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L135) +[packages/medusa-js/src/resources/admin/orders.ts:135](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L135) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`FindParams`](internal-5.FindParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`FindParams`](internal-6.FindParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L34) +[packages/medusa-js/src/resources/admin/orders.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L34) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostOrdersOrderReq`](internal-14.AdminPostOrdersOrderReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderReq`](internal-8.internal.AdminPostOrdersOrderReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L25) +[packages/medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L25) ___ ### updateClaim -▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Parameters @@ -547,13 +551,13 @@ ___ | :------ | :------ | | `id` | `string` | | `claimId` | `string` | -| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-14.AdminPostOrdersOrderClaimsClaimReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-14.md#adminordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminOrdersRes`](../modules/internal-8.internal.md#adminordersres)\> #### Defined in -[medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/orders.ts#L234) +[packages/medusa-js/src/resources/admin/orders.ts:234](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/orders.ts#L234) diff --git a/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md b/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md index 466a7a868e..96fdbe4498 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminPaymentCollectionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPaymentCollectionsResource ## Hierarchy @@ -10,84 +14,84 @@ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-15.md#adminpaymentcollectiondeleteres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../modules/internal-8.internal.md#adminpaymentcollectiondeleteres)\> #### Defined in -[medusa-js/src/resources/admin/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L36) +[packages/medusa-js/src/resources/admin/payment-collections.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L36) ___ ### markAsAuthorized -▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/admin/payment-collections.ts:44](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L44) +[packages/medusa-js/src/resources/admin/payment-collections.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L44) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetPaymentCollectionsParams`](internal-8.internal.AdminGetPaymentCollectionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/admin/payment-collections.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L12) +[packages/medusa-js/src/resources/admin/payment-collections.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L12) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-15.AdminUpdatePaymentCollectionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminUpdatePaymentCollectionsReq`](internal-8.internal.AdminUpdatePaymentCollectionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-15.md#adminpaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentCollectionsRes`](../modules/internal-8.internal.md#adminpaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/admin/payment-collections.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payment-collections.ts#L27) +[packages/medusa-js/src/resources/admin/payment-collections.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payment-collections.ts#L27) diff --git a/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md b/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md index bbc0f3282a..9ec1419054 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPaymentsResource ## Hierarchy @@ -10,63 +14,63 @@ ### capturePayment -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> +▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> #### Defined in -[medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L27) +[packages/medusa-js/src/resources/admin/payments.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L27) ___ ### refundPayment -▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> +▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPaymentRefundsReq`](internal-16.AdminPostPaymentRefundsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPaymentRefundsReq`](internal-8.internal.AdminPostPaymentRefundsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRefundRes`](../modules/internal-16.md#adminrefundres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRefundRes`](../modules/internal-8.internal.md#adminrefundres)\> #### Defined in -[medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L35) +[packages/medusa-js/src/resources/admin/payments.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L35) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`GetPaymentsParams`](internal-8.internal.GetPaymentsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-16.md#adminpaymentres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentRes`](../modules/internal-8.internal.md#adminpaymentres)\> #### Defined in -[medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/payments.ts#L12) +[packages/medusa-js/src/resources/admin/payments.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/payments.ts#L12) diff --git a/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md b/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md index c888fd60bc..203d74320e 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminPriceListResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPriceListResource ## Hierarchy @@ -10,93 +14,93 @@ ### addPrices -▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-17.AdminPostPriceListPricesPricesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPriceListPricesPricesReq`](internal-8.internal.AdminPostPriceListPricesPricesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L80) +[packages/medusa-js/src/resources/admin/price-lists.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L81) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostPriceListsPriceListReq`](internal-17.AdminPostPriceListsPriceListReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPriceListsPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L18) +[packages/medusa-js/src/resources/admin/price-lists.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L19) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L35) +[packages/medusa-js/src/resources/admin/price-lists.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L36) ___ ### deletePrices -▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-17.AdminDeletePriceListPricesPricesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal-8.internal.AdminDeletePriceListPricesPricesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L89) +[packages/medusa-js/src/resources/admin/price-lists.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L90) ___ ### deleteProductPrices -▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Parameters @@ -104,21 +108,43 @@ ___ | :------ | :------ | | `priceListId` | `string` | | `productId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L98) +[packages/medusa-js/src/resources/admin/price-lists.ts:99](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L99) + +___ + +### deleteProductsPrices + +▸ **deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `payload` | [`AdminDeletePriceListsPriceListProductsPricesBatchReq`](internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/price-lists.ts:117](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L117) ___ ### deleteVariantPrices -▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Parameters @@ -126,98 +152,98 @@ ___ | :------ | :------ | | `priceListId` | `string` | | `variantId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-17.md#adminpricelistdeletebatchres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal-8.internal.md#adminpricelistdeletebatchres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L107) +[packages/medusa-js/src/resources/admin/price-lists.ts:108](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L108) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-17.md#adminpricelistslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal-8.internal.md#adminpricelistslistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L51) +[packages/medusa-js/src/resources/admin/price-lists.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L52) ___ ### listProducts -▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-17.AdminGetPriceListsPriceListProductsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`any`\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L65) +[packages/medusa-js/src/resources/admin/price-lists.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L66) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L43) +[packages/medusa-js/src/resources/admin/price-lists.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L44) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-17.AdminPostPriceListsPriceListPriceListReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-17.md#adminpricelistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPriceListRes`](../modules/internal-8.internal.md#adminpricelistres)\> #### Defined in -[medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/price-lists.ts#L26) +[packages/medusa-js/src/resources/admin/price-lists.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/price-lists.ts#L27) diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md b/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md new file mode 100644 index 0000000000..f2a45ac19f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/AdminProductCategoriesResource.md @@ -0,0 +1,222 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminProductCategoriesResource + +## Hierarchy + +- `default` + + ↳ **`AdminProductCategoriesResource`** + +## Methods + +### addProducts + +▸ **addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +Add products to a product category + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategoryId` | `string` | +| `payload` | [`AdminPostProductCategoriesCategoryProductsBatchReq`](internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +a medusa product category + +**`Description`** + +Add products to a product category + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:126](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L126) + +___ + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostProductCategoriesReq`](internal-8.internal.AdminPostProductCategoriesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L44) + +___ + +### delete + +▸ **delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +Delete a product category + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategoryId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +an deletion result + +**`Description`** + +gets a product category + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:95](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L95) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesListRes`](../modules/internal-8.internal.md#adminproductcategorieslistres)\> + +Retrieve a list of product categories + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetProductCategoriesParams`](internal-8.internal.AdminGetProductCategoriesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesListRes`](../modules/internal-8.internal.md#adminproductcategorieslistres)\> + +the list of product category as well as the pagination properties + +**`Description`** + +Retrieve a list of product categories + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L74) + +___ + +### removeProducts + +▸ **removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +Remove products from a product category + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategoryId` | `string` | +| `payload` | [`AdminDeleteProductCategoriesCategoryProductsBatchReq`](internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +a medusa product category + +**`Description`** + +Remove products from a product category + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:110](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L110) + +___ + +### retrieve + +▸ **retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +retrieve a product category + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategoryId` | `string` | +| `query?` | [`AdminGetProductCategoryParams`](internal-8.internal.AdminGetProductCategoryParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +a medusa product category + +**`Description`** + +gets a product category + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L25) + +___ + +### update + +▸ **update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +update a product category + This feature is under development and may change in the future. +To use this feature please enable featureflag `product_categories` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategoryId` | `string` | +| `payload` | [`AdminPostProductCategoriesCategoryReq`](internal-8.internal.AdminPostProductCategoriesCategoryReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductCategoriesCategoryRes`](../modules/internal-8.internal.md#adminproductcategoriescategoryres)\> + +the updated medusa product category + +**`Description`** + +updates a product category + +#### Defined in + +[packages/medusa-js/src/resources/admin/product-categories.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-categories.ts#L58) diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md b/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md index e61fa2af38..7a4d3ba153 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminProductTagsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminProductTagsResource ## Hierarchy @@ -10,18 +14,18 @@ ### list -▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> +▸ **list**(`query?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) | +| `query?` | [`AdminGetProductTagsParams`](internal-8.internal.AdminGetProductTagsParams.md) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-18.md#adminproducttagslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal-8.internal.md#adminproducttagslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/product-tags.ts#L10) +[packages/medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-tags.ts#L10) diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md b/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md index 4ebaf4d62f..7c6c9ea304 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminProductTypesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminProductTypesResource ## Hierarchy @@ -10,19 +14,19 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-19.md#adminproducttypeslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal-8.internal.md#adminproducttypeslistres)\> #### Defined in -[medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/product-types.ts#L10) +[packages/medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/product-types.ts#L10) diff --git a/www/apps/docs/content/references/js-client/classes/AdminProductsResource.md b/www/apps/docs/content/references/js-client/classes/AdminProductsResource.md index a88d2dafb0..c453bb49c7 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminProductsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminProductsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminProductsResource ## Hierarchy @@ -10,93 +14,93 @@ ### addOption -▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductOptionsReq`](internal-20.AdminPostProductsProductOptionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductOptionsReq`](internal-8.internal.AdminPostProductsProductOptionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L124) +[packages/medusa-js/src/resources/admin/products.ts:124](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L124) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostProductsReq`](internal-20.AdminPostProductsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsReq`](internal-8.internal.AdminPostProductsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L23) +[packages/medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L23) ___ ### createVariant -▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductVariantsReq`](internal-20.AdminPostProductsProductVariantsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductVariantsReq`](internal-8.internal.AdminPostProductsProductVariantsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L96) +[packages/medusa-js/src/resources/admin/products.ts:96](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L96) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-20.md#adminproductsdeleteres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal-8.internal.md#adminproductsdeleteres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L48) +[packages/medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L48) ___ ### deleteOption -▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> +▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\> #### Parameters @@ -104,21 +108,21 @@ ___ | :------ | :------ | | `id` | `string` | | `optionId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-20.md#adminproductsdeleteoptionres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal-8.internal.md#adminproductsdeleteoptionres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L143) +[packages/medusa-js/src/resources/admin/products.ts:143](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L143) ___ ### deleteVariant -▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> +▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\> #### Parameters @@ -126,151 +130,151 @@ ___ | :------ | :------ | | `id` | `string` | | `variantId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-20.md#adminproductsdeletevariantres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal-8.internal.md#adminproductsdeletevariantres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L115) +[packages/medusa-js/src/resources/admin/products.ts:115](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L115) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetProductsParams`](internal-8.internal.AdminGetProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-20.md#adminproductslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListRes`](../modules/internal-8.internal.md#adminproductslistres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L56) +[packages/medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L56) ___ ### listTags -▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> +▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-20.md#adminproductslisttagsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal-8.internal.md#adminproductslisttagsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L80) +[packages/medusa-js/src/resources/admin/products.ts:80](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L80) ___ ### listTypes -▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> - -**`Deprecated`** - -Use [list](AdminProductTypesResource.md#list) instead. +▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-20.md#adminproductslisttypesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal-8.internal.md#adminproductslisttypesres)\> + +**`Deprecated`** + +Use [AdminProductTypesResource.list](AdminProductTypesResource.md#list) instead. #### Defined in -[medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L73) +[packages/medusa-js/src/resources/admin/products.ts:73](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L73) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L31) +[packages/medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L31) ___ ### setMetadata -▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductMetadataReq`](internal-20.AdminPostProductsProductMetadataReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductMetadataReq`](internal-8.internal.AdminPostProductsProductMetadataReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L87) +[packages/medusa-js/src/resources/admin/products.ts:87](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L87) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostProductsProductReq`](internal-20.AdminPostProductsProductReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductReq`](internal-8.internal.AdminPostProductsProductReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L39) +[packages/medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L39) ___ ### updateOption -▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters @@ -278,22 +282,22 @@ ___ | :------ | :------ | | `id` | `string` | | `optionId` | `string` | -| `payload` | [`AdminPostProductsProductOptionsOption`](internal-20.AdminPostProductsProductOptionsOption.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductOptionsOption`](internal-8.internal.AdminPostProductsProductOptionsOption.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L133) +[packages/medusa-js/src/resources/admin/products.ts:133](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L133) ___ ### updateVariant -▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Parameters @@ -301,13 +305,13 @@ ___ | :------ | :------ | | `id` | `string` | | `variantId` | `string` | -| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-20.AdminPostProductsProductVariantsVariantReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal-20.md#adminproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminProductsRes`](../modules/internal-8.internal.md#adminproductsres)\> #### Defined in -[medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/products.ts#L105) +[packages/medusa-js/src/resources/admin/products.ts:105](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/products.ts#L105) diff --git a/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md b/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md index 25098390c9..37cb6930e9 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminPublishableApiKeyResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPublishableApiKeyResource ## Hierarchy @@ -10,136 +14,136 @@ ### addSalesChannelsBatch -▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:82](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L82) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:82](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L82) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostPublishableApiKeysReq`](internal-21.AdminPostPublishableApiKeysReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPublishableApiKeysReq`](internal-8.internal.AdminPostPublishableApiKeysReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L49) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L49) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L66) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L66) ___ ### deleteSalesChannelsBatch -▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeletePublishableApiKeySalesChannelsBatchReq`](internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:91](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L91) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:91](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L91) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`GetPublishableApiKeysParams`](internal-21.GetPublishableApiKeysParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`GetPublishableApiKeysParams`](internal-8.internal.GetPublishableApiKeysParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-21.md#adminpublishableapikeyslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysListRes`](../modules/internal-8.internal.md#adminpublishableapikeyslistres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L35) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L35) ___ ### listSalesChannels -▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> +▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-21.GetPublishableApiKeySalesChannelsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`GetPublishableApiKeySalesChannelsParams`](internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L100) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:100](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L100) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Parameters @@ -147,36 +151,36 @@ ___ | :------ | :------ | | `id` | `string` | | `query?` | `Object` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L20) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L20) ___ ### revoke -▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-21.md#adminpublishableapikeysres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPublishableApiKeysRes`](../modules/internal-8.internal.md#adminpublishableapikeysres)\> #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L74) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L74) ___ @@ -189,8 +193,8 @@ ___ | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostPublishableApiKeysPublishableApiKeyReq`](internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns @@ -198,4 +202,4 @@ ___ #### Defined in -[medusa-js/src/resources/admin/publishable-api-keys.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L57) +[packages/medusa-js/src/resources/admin/publishable-api-keys.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/publishable-api-keys.ts#L57) diff --git a/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md b/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md index 04d6db32c2..b6f9e65076 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminRegionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminRegionsResource ## Hierarchy @@ -10,149 +14,145 @@ ### addCountry -▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-8.internal.AdminPostRegionsRegionCountriesReq.md) | country data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> + +updated region **`Description`** adds a country to the list of countries in a region -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-22.AdminPostRegionsRegionCountriesReq.md) | country data | -| `customHeaders` | `Record`<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -updated region - #### Defined in -[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L103) +[packages/medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L103) ___ ### addFulfillmentProvider -▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | region id | +| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> + +updated region **`Description`** adds a fulfillment provider to a region -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data | -| `customHeaders` | `Record`<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -updated region - #### Defined in -[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L135) +[packages/medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L135) ___ ### addPaymentProvider -▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -adds a payment provider to a region +▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> updated region +**`Description`** + +adds a payment provider to a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L181) +[packages/medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L181) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -creates a region. +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostRegionsReq`](internal-8.internal.AdminPostRegionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> created region. +**`Description`** + +creates a region. + #### Defined in -[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L24) +[packages/medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L24) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -deletes a region +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of region to delete. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> Deleted response +**`Description`** + +deletes a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L54) +[packages/medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L54) ___ ### deleteCountry -▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -remove a country from a region's list of coutnries +▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters @@ -160,27 +160,27 @@ remove a country from a region's list of coutnries | :------ | :------ | :------ | | `id` | `string` | region id | | `country_code` | `string` | the 2 character ISO code for the Country. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> updated region +**`Description`** + +remove a country from a region's list of coutnries + #### Defined in -[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L119) +[packages/medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L119) ___ ### deleteFulfillmentProvider -▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -remove a fulfillment provider from a region +▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters @@ -188,27 +188,27 @@ remove a fulfillment provider from a region | :------ | :------ | :------ | | `id` | `string` | region id | | `provider_id` | `string` | the if of the fulfillment provider | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> updated region +**`Description`** + +remove a fulfillment provider from a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L151) +[packages/medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L151) ___ ### deletePaymentProvider -▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -removes a payment provider from a region +▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters @@ -216,123 +216,127 @@ removes a payment provider from a region | :------ | :------ | :------ | | `id` | `string` | region id | | `provider_id` | `string` | the id of the payment provider | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> updated region +**`Description`** + +removes a payment provider from a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L197) +[packages/medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L197) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\> - -**`Description`** - -lists regions matching a query +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) | query for searching regions | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetRegionsParams`](internal-8.internal.AdminGetRegionsParams.md) | query for searching regions | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-8.internal.md#adminregionslistres)\> a list of regions matching the query. +**`Description`** + +lists regions matching a query + #### Defined in -[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L82) +[packages/medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L82) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -get a region +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the region to retrieve. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> the region with the given id +**`Description`** + +get a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L68) +[packages/medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L68) ___ ### retrieveFulfillmentOptions -▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> - -**`Description`** - -retrieves the list of fulfillment options available in a region +▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | region id | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\> list of fulfillment options +**`Description`** + +retrieves the list of fulfillment options available in a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L166) +[packages/medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L166) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> - -**`Description`** - -updates a region +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the region to update. | -| `payload` | [`AdminPostRegionsRegionReq`](internal-22.AdminPostRegionsRegionReq.md) | update to apply to region. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostRegionsRegionReq`](internal-8.internal.AdminPostRegionsRegionReq.md) | update to apply to region. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminRegionsRes`](internal-8.internal.AdminRegionsRes.md)\> the updated region. +**`Description`** + +updates a region + #### Defined in -[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/regions.ts#L39) +[packages/medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/regions.ts#L39) diff --git a/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md b/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md new file mode 100644 index 0000000000..7c9fdfb88d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/AdminReservationsResource.md @@ -0,0 +1,167 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminReservationsResource + +## Hierarchy + +- `default` + + ↳ **`AdminReservationsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +create a reservation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostReservationsReq`](internal-8.internal.AdminPostReservationsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +the created reservation + +**`Description`** + +create a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Defined in + +[packages/medusa-js/src/resources/admin/reservations.ts:57](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L57) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +remove a reservation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> + +reservation removal confirmation + +**`Description`** + +remove a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Defined in + +[packages/medusa-js/src/resources/admin/reservations.ts:88](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L88) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsListRes`](../modules/internal-8.internal.md#adminreservationslistres)\> + +List reservations + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetReservationsParams`](internal-8.internal.AdminGetReservationsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsListRes`](../modules/internal-8.internal.md#adminreservationslistres)\> + +A list of reservations matching the provided query + +**`Description`** + +Lists reservations + +#### Defined in + +[packages/medusa-js/src/resources/admin/reservations.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L36) + +___ + +### retrieve + +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +Get a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +The reservation with the provided id + +**`Description`** + +gets a reservation + +#### Defined in + +[packages/medusa-js/src/resources/admin/reservations.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L21) + +___ + +### update + +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +update a reservation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `payload` | [`AdminPostReservationsReservationReq`](internal-8.internal.AdminPostReservationsReservationReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReservationsRes`](../modules/internal-8.internal.md#adminreservationsres)\> + +The updated reservation + +**`Description`** + +update a reservation + This feature is under development and may change in the future. +To use this feature please install @medusajs/inventory + +#### Defined in + +[packages/medusa-js/src/resources/admin/reservations.ts:72](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/reservations.ts#L72) diff --git a/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md b/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md index d40c01c5cb..b7e3bc80a0 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminReturnReasonsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminReturnReasonsResource ## Hierarchy @@ -10,133 +14,133 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> - -**`Description`** - -Creates a return reason. +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostReturnReasonsReq`](internal-23.AdminPostReturnReasonsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostReturnReasonsReq`](internal-8.internal.AdminPostReturnReasonsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> Created return reason. +**`Description`** + +Creates a return reason. + #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) +[packages/medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L18) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -deletes a return reason +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of return reason to delete. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> Deleted response +**`Description`** + +deletes a return reason + #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) +[packages/medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L48) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\> - -**`Description`** - -Lists return reasons matching a query +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-23.md#adminreturnreasonslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal-8.internal.md#adminreturnreasonslistres)\> a list of return reasons matching the query. +**`Description`** + +Lists return reasons matching a query + #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) +[packages/medusa-js/src/resources/admin/return-reasons.ts:75](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L75) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> - -**`Description`** - -retrieves a return reason +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return reason to retrieve. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> the return reason with the given id +**`Description`** + +retrieves a return reason + #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) +[packages/medusa-js/src/resources/admin/return-reasons.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L62) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> - -**`Description`** - -Updates a return reason +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return reason to update. | -| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-23.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostReturnReasonsReasonReq`](internal-8.internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-23.md#adminreturnreasonsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal-8.internal.md#adminreturnreasonsres)\> the updated return reason. +**`Description`** + +Updates a return reason + #### Defined in -[medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) +[packages/medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/return-reasons.ts#L33) diff --git a/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md b/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md index e9925f106b..1a728a1602 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminReturnsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminReturnsResource ## Hierarchy @@ -10,80 +14,80 @@ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\> - -**`Description`** - -cancels a return +▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-8.internal.md#adminreturnscancelres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of return to cancel | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-24.md#adminreturnscancelres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal-8.internal.md#adminreturnscancelres)\> the order for which the return was canceled +**`Description`** + +cancels a return + #### Defined in -[medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L19) +[packages/medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L19) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\> - -**`Description`** - -lists returns matching a query +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetReturnsParams`](internal-24.AdminGetReturnsParams.md) | query for searching returns | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetReturnsParams`](internal-8.internal.AdminGetReturnsParams.md) | query for searching returns | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-24.md#adminreturnslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal-8.internal.md#adminreturnslistres)\> a list of returns matching the query +**`Description`** + +lists returns matching a query + #### Defined in -[medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L49) +[packages/medusa-js/src/resources/admin/returns.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L49) ___ ### receive -▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> - -**`Description`** - -receive a return +▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the return to receive. | -| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-24.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal-8.internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-24.md#adminreturnsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminReturnsRes`](../modules/internal-8.internal.md#adminreturnsres)\> the return +**`Description`** + +receive a return + #### Defined in -[medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/returns.ts#L34) +[packages/medusa-js/src/resources/admin/returns.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/returns.ts#L34) diff --git a/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md b/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md index 6ea13bc169..7b9bab2e77 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminSalesChannelsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminSalesChannelsResource ## Hierarchy @@ -8,210 +12,274 @@ ## Methods -### addProducts +### addLocation -▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> -Add products to a sales channel +Add a location to a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. -**`Description`** - -Add products to a sales channel - #### Parameters | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> -a medusa sales channel +the Medusa SalesChannel + +**`Description`** + +Add a stock location to a SalesChannel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L116) +[packages/medusa-js/src/resources/admin/sales-channels.ts:134](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L134) + +___ + +### addProducts + +▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> + +Add products to a sales channel + This feature is under development and may change in the future. +To use this feature please enable featureflag `sales_channels` in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `salesChannelId` | `string` | +| `payload` | [`AdminPostSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> + +a medusa sales channel + +**`Description`** + +Add products to a sales channel + +#### Defined in + +[packages/medusa-js/src/resources/admin/sales-channels.ts:118](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L118) ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostSalesChannelsReq`](internal-25.AdminPostSalesChannelsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostSalesChannelsReq`](internal-8.internal.AdminPostSalesChannelsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L34) +[packages/medusa-js/src/resources/admin/sales-channels.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L36) ___ ### delete -▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> Delete a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. -**`Description`** - -gets a sales channel - #### Parameters | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> an deletion result +**`Description`** + +gets a sales channel + #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:85](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L85) +[packages/medusa-js/src/resources/admin/sales-channels.ts:87](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L87) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> Retrieve a list of sales channels This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetSalesChannelsParams`](internal-8.internal.AdminGetSalesChannelsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-8.internal.md#adminsaleschannelslistres)\> + +the list of sales channel as well as the pagination properties + **`Description`** Retrieve a list of sales channels +#### Defined in + +[packages/medusa-js/src/resources/admin/sales-channels.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L66) + +___ + +### removeLocation + +▸ **removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> + +remove a location from a sales channel + This feature is under development and may change in the future. +To use this feature please enable featureflag `sales_channels` in your medusa backend project. + #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetSalesChannelsParams`](internal-25.AdminGetSalesChannelsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `salesChannelId` | `string` | +| `payload` | [`AdminDeleteSalesChannelsChannelStockLocationsReq`](internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsListRes`](../modules/internal-21.md#adminsaleschannelslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> -the list of sales channel as well as the pagination properties +an deletion result + +**`Description`** + +Remove a stock location from a SalesChannel #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L64) +[packages/medusa-js/src/resources/admin/sales-channels.ts:150](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L150) ___ ### removeProducts -▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> Remove products from a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. -**`Description`** - -Remove products from a sales channel - #### Parameters | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteSalesChannelsChannelProductsBatchReq`](internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> a medusa sales channel +**`Description`** + +Remove products from a sales channel + #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L100) +[packages/medusa-js/src/resources/admin/sales-channels.ts:102](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L102) ___ ### retrieve -▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> retrieve a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. -**`Description`** - -gets a sales channel - #### Parameters | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> a medusa sales channel +**`Description`** + +gets a sales channel + #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L22) +[packages/medusa-js/src/resources/admin/sales-channels.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L24) ___ ### update -▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> update a sales channel This feature is under development and may change in the future. To use this feature please enable featureflag `sales_channels` in your medusa backend project. -**`Description`** - -updates a sales channel - #### Parameters | Name | Type | | :------ | :------ | | `salesChannelId` | `string` | -| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-25.AdminPostSalesChannelsSalesChannelReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostSalesChannelsSalesChannelReq`](internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-25.md#adminsaleschannelsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSalesChannelsRes`](../modules/internal-8.internal.md#adminsaleschannelsres)\> the updated medusa sales channel +**`Description`** + +updates a sales channel + #### Defined in -[medusa-js/src/resources/admin/sales-channels.ts:48](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/sales-channels.ts#L48) +[packages/medusa-js/src/resources/admin/sales-channels.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/sales-channels.ts#L50) diff --git a/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md b/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md index abaf96630a..02d3616afa 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminShippingOptionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminShippingOptionsResource ## Hierarchy @@ -10,134 +14,134 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> - -**`Description`** - -creates a shipping option. +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingOptionsReq`](internal-26.AdminPostShippingOptionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostShippingOptionsReq`](internal-8.internal.AdminPostShippingOptionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> created shipping option. +**`Description`** + +creates a shipping option. + #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) +[packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L20) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -deletes a shipping option +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of shipping option to delete. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> deleted response +**`Description`** + +deletes a shipping option + #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) +[packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L50) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\> - -**`Description`** - -lists shipping options matching a query +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`AdminGetShippingOptionsParams`](internal-26.AdminGetShippingOptionsParams.md) | query for searching shipping options | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`AdminGetShippingOptionsParams`](internal-8.internal.AdminGetShippingOptionsParams.md) | query for searching shipping options | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-26.md#adminshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal-8.internal.md#adminshippingoptionslistres)\> a list of shipping options matching the query. +**`Description`** + +lists shipping options matching a query + #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) +[packages/medusa-js/src/resources/admin/shipping-options.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L78) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> - -**`Description`** - -get a shipping option +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the shipping option to retrieve. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> the shipping option with the given id +**`Description`** + +get a shipping option + #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) +[packages/medusa-js/src/resources/admin/shipping-options.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L64) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> - -**`Description`** - -updates a shipping option +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the shipping option to update. | -| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-26.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostShippingOptionsOptionReq`](internal-8.internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-26.md#adminshippingoptionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal-8.internal.md#adminshippingoptionsres)\> the updated shipping option. +**`Description`** + +updates a shipping option + #### Defined in -[medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) +[packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-options.ts#L35) diff --git a/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md b/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md index 709c312d7f..013afce3a3 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminShippingProfilesResource ## Hierarchy @@ -10,103 +14,103 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostShippingProfilesReq`](internal-27.AdminPostShippingProfilesReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostShippingProfilesReq`](internal-8.internal.AdminPostShippingProfilesReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:29](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L29) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-27.md#adminshippingprofileslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal-8.internal.md#adminshippingprofileslistres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L45) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-27.AdminPostShippingProfilesProfileReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostShippingProfilesProfileReq`](internal-8.internal.AdminPostShippingProfilesProfileReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-27.md#adminshippingprofilesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal-8.internal.md#adminshippingprofilesres)\> #### Defined in -[medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20) +[packages/medusa-js/src/resources/admin/shipping-profiles.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L20) diff --git a/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md b/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md new file mode 100644 index 0000000000..c658a88d7a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/AdminStockLocationsResource.md @@ -0,0 +1,165 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminStockLocationsResource + +## Hierarchy + +- `default` + + ↳ **`AdminStockLocationsResource`** + +## Methods + +### create + +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +Create a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/stock-location + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payload` | [`AdminPostStockLocationsReq`](internal-8.internal.AdminPostStockLocationsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +a medusa Stock Location + +**`Description`** + +gets a medusa Stock Location + +#### Defined in + +[packages/medusa-js/src/resources/admin/stock-locations.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L21) + +___ + +### delete + +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.md#deleteresponse)\> + +Delete a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/stock-location + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.md#deleteresponse)\> + +**`Description`** + +deletes a Stock Location + +#### Defined in + +[packages/medusa-js/src/resources/admin/stock-locations.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L66) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsListRes`](../modules/internal-8.internal.md#adminstocklocationslistres)\> + +Retrieve a list of Stock Locations + This feature is under development and may change in the future. +To use this feature please install @medusajs/stock-location + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `query?` | [`AdminGetStockLocationsParams`](internal-8.internal.AdminGetStockLocationsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsListRes`](../modules/internal-8.internal.md#adminstocklocationslistres)\> + +the list of Stock Locations as well as the pagination properties + +**`Description`** + +Retrieve a list of Stock Locations + +#### Defined in + +[packages/medusa-js/src/resources/admin/stock-locations.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L81) + +___ + +### retrieve + +▸ **retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +Retrieve a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/stock-location + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemId` | `string` | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +a medusa Stock Location + +**`Description`** + +gets a medusa Stock Location + +#### Defined in + +[packages/medusa-js/src/resources/admin/stock-locations.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L36) + +___ + +### update + +▸ **update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +Update a Stock Location + This feature is under development and may change in the future. +To use this feature please install @medusajs/stock-location + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stockLocationId` | `string` | +| `payload` | [`AdminPostStockLocationsLocationReq`](internal-8.internal.AdminPostStockLocationsLocationReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStockLocationsRes`](../modules/internal-8.internal.md#adminstocklocationsres)\> + +the updated medusa Stock Location + +**`Description`** + +updates a Stock Location + +#### Defined in + +[packages/medusa-js/src/resources/admin/stock-locations.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/stock-locations.ts#L51) diff --git a/www/apps/docs/content/references/js-client/classes/AdminStoresResource.md b/www/apps/docs/content/references/js-client/classes/AdminStoresResource.md index d560d7ba13..c5bc8863bc 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminStoresResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminStoresResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminStoresResource ## Hierarchy @@ -10,157 +14,157 @@ ### addCurrency -▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> - -**`Description`** - -adds a currency to the store. +▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `currency_code` | `string` | code of the currency to add | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> updated store. +**`Description`** + +adds a currency to the store. + #### Defined in -[medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L31) +[packages/medusa-js/src/resources/admin/store.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L32) ___ ### deleteCurrency -▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> - -**`Description`** - -deletes a currency from the available store currencies +▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `currency_code` | `string` | currency code of the currency to delete from the store. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> updated store +**`Description`** + +deletes a currency from the available store currencies + #### Defined in -[medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L45) +[packages/medusa-js/src/resources/admin/store.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L46) ___ ### listPaymentProviders -▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\> - -**`Description`** - -Lists the store's payment providers +▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-28.md#adminpaymentproviderslist)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal-8.internal.md#adminpaymentproviderslist)\> a list of payment providers configured on the store +**`Description`** + +Lists the store's payment providers + #### Defined in -[medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L68) +[packages/medusa-js/src/resources/admin/store.ts:69](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L69) ___ ### listTaxProviders -▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.md#admintaxproviderslist)\> +▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-8.internal.md#admintaxproviderslist)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-8.internal.md#admintaxproviderslist)\> + +a list of payment providers configured on the store **`Description`** Lists the store's payment providers -#### Parameters - -| Name | Type | -| :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal-28.md#admintaxproviderslist)\> - -a list of payment providers configured on the store - #### Defined in -[medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L79) +[packages/medusa-js/src/resources/admin/store.ts:80](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L80) ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> - -**`Description`** - -gets a medusa store +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminExtendedStoresRes`](../modules/internal-8.internal.md#adminextendedstoresres)\> a medusa store +**`Description`** + +gets a medusa store + #### Defined in -[medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L57) +[packages/medusa-js/src/resources/admin/store.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L58) ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> - -**`Description`** - -Updates the store +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminPostStoreReq`](internal-28.AdminPostStoreReq.md) | update to apply to the store. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminPostStoreReq`](internal-8.internal.AdminPostStoreReq.md) | update to apply to the store. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal-28.md#adminstoresres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminStoresRes`](../modules/internal-8.internal.md#adminstoresres)\> the updated store. +**`Description`** + +Updates the store + #### Defined in -[medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/store.ts#L17) +[packages/medusa-js/src/resources/admin/store.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/store.ts#L18) diff --git a/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md b/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md index 50b5001b52..1e2b066d97 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminSwapsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminSwapsResource ## Hierarchy @@ -10,40 +14,40 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetSwapsParams`](internal-29.AdminGetSwapsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetSwapsParams`](internal-8.internal.AdminGetSwapsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-29.md#adminswapslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal-8.internal.md#adminswapslistres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/swaps.ts#L19) +[packages/medusa-js/src/resources/admin/swaps.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/swaps.ts#L19) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-29.md#adminswapsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminSwapsRes`](../modules/internal-8.internal.md#adminswapsres)\> #### Defined in -[medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/swaps.ts#L11) +[packages/medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/swaps.ts#L11) diff --git a/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md b/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md index 5f9f189e9a..084296647a 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminTaxRatesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminTaxRatesResource ## Hierarchy @@ -10,245 +14,245 @@ ### addProductTypes -▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) +[packages/medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L100) ___ ### addProducts -▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-30.AdminPostTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) +[packages/medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L84) ___ ### addShippingOptions -▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) +[packages/medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L116) ___ ### create -▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostTaxRatesReq`](internal-30.AdminPostTaxRatesReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostTaxRatesReq`](internal-8.internal.AdminPostTaxRatesReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) +[packages/medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L53) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) +[packages/medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L180) ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`AdminGetTaxRatesParams`](internal-30.AdminGetTaxRatesParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetTaxRatesParams`](internal-8.internal.AdminGetTaxRatesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-30.md#admintaxrateslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal-8.internal.md#admintaxrateslistres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) +[packages/medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L39) ___ ### removeProductTypes -▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) +[packages/medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L148) ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) +[packages/medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L132) ___ ### removeShippingOptions -▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | -| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) | +| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) +[packages/medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L164) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) +[packages/medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L24) ___ ### update -▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-30.AdminPostTaxRatesTaxRateReq.md) | -| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-30.AdminGetTaxRatesTaxRateParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal-8.internal.AdminPostTaxRatesTaxRateReq.md) | +| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal-8.internal.AdminGetTaxRatesTaxRateParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-30.md#admintaxratesres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal-8.internal.md#admintaxratesres)\> #### Defined in -[medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) +[packages/medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/tax-rates.ts#L68) diff --git a/www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md b/www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md index e2d9e1985c..a26b8ee004 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminUploadsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminUploadsResource ## Hierarchy @@ -20,86 +24,118 @@ #### Defined in -[medusa-js/src/resources/admin/uploads.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L14) +[packages/medusa-js/src/resources/admin/uploads.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L12) ## Methods -### create +### \_createPayload -▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> +▸ `Private` **_createPayload**(`file`): `FormData` #### Parameters | Name | Type | | :------ | :------ | -| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | +| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> +`FormData` #### Defined in -[medusa-js/src/resources/admin/uploads.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L18) +[packages/medusa-js/src/resources/admin/uploads.ts:62](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L62) + +___ + +### create + +▸ **create**(`file`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | File or array of files to upload. | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\> + +Uploaded file or files. + +**`Description`** + +Uploads at least one file to the specific fileservice that is installed in Medusa. + +#### Defined in + +[packages/medusa-js/src/resources/admin/uploads.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L21) ___ ### createProtected -▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> +▸ **createProtected**(`file`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\> #### Parameters -| Name | Type | -| :------ | :------ | -| `file` | [`IAdminPostUploadsFileReq`](internal-31.IAdminPostUploadsFileReq.md) | +| Name | Type | Description | +| :------ | :------ | :------ | +| `file` | [`AdminCreateUploadPayload`](../modules/internal-10.md#admincreateuploadpayload) | File or array of files to upload. | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-31.md#adminuploadsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsRes`](../modules/internal-8.internal.md#adminuploadsres)\> + +Uploaded file or files. + +**`Description`** + +Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa. #### Defined in -[medusa-js/src/resources/admin/uploads.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L27) +[packages/medusa-js/src/resources/admin/uploads.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L34) ___ ### delete -▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminDeleteUploadsReq`](internal-31.AdminDeleteUploadsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminDeleteUploadsReq`](internal-8.internal.AdminDeleteUploadsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L36) +[packages/medusa-js/src/resources/admin/uploads.ts:44](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L44) ___ ### getPresignedDownloadUrl -▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> +▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-31.AdminPostUploadsDownloadUrlReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`AdminPostUploadsDownloadUrlReq`](internal-8.internal.AdminPostUploadsDownloadUrlReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-31.md#adminuploadsdownloadurlres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUploadsDownloadUrlRes`](../modules/internal-8.internal.md#adminuploadsdownloadurlres)\> #### Defined in -[medusa-js/src/resources/admin/uploads.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/uploads.ts#L45) +[packages/medusa-js/src/resources/admin/uploads.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/uploads.ts#L53) diff --git a/www/apps/docs/content/references/js-client/classes/AdminUsersResource.md b/www/apps/docs/content/references/js-client/classes/AdminUsersResource.md index e1c521a3c8..d50c493d71 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminUsersResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminUsersResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminUsersResource ## Hierarchy @@ -10,112 +14,112 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> - -**`Description`** - -creates a user with the provided information +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminCreateUserPayload`](../modules/internal-32.md#admincreateuserpayload) | user creation request body | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminCreateUserPayload`](../modules/internal-11.md#admincreateuserpayload) | user creation request body | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> created user +**`Description`** + +creates a user with the provided information + #### Defined in -[medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L64) +[packages/medusa-js/src/resources/admin/users.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L64) ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> - -**`Description`** - -deletes a user +▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the user to be deleted | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\> delete response +**`Description`** + +deletes a user + #### Defined in -[medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L94) +[packages/medusa-js/src/resources/admin/users.ts:94](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L94) ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> - -**`Description`** - -lists all users +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-32.md#adminuserslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUsersListRes`](../modules/internal-8.internal.md#adminuserslistres)\> a list of all users +**`Description`** + +lists all users + #### Defined in -[medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L106) +[packages/medusa-js/src/resources/admin/users.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L106) ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> - -**`Description`** - -resets the users password given the correct token. +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordRequest`](internal-32.AdminResetPasswordRequest.md) | reset password information. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminResetPasswordRequest`](internal-8.internal.AdminResetPasswordRequest.md) | reset password information. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> + +**`Description`** + +resets the users password given the correct token. #### Defined in -[medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L36) +[packages/medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L36) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> Retrieves a given user @@ -124,67 +128,67 @@ Retrieves a given user | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the user | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> the user #### Defined in -[medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L50) +[packages/medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L50) ___ ### sendResetPasswordToken -▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> - -**`Description`** - -resets password by re-sending password token. +▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`AdminResetPasswordTokenRequest`](internal-32.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminResetPasswordTokenRequest`](internal-8.internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> + +**`Description`** + +resets password by re-sending password token. #### Defined in -[medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L22) +[packages/medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L22) ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> - -**`Description`** - -updates a given user +▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the user to update | -| `payload` | [`AdminUpdateUserPayload`](../modules/internal-32.md#adminupdateuserpayload) | user update request body | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`AdminUpdateUserPayload`](../modules/internal-11.md#adminupdateuserpayload) | user update request body | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal-32.md#adminuserres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminUserRes`](../modules/internal-8.internal.md#adminuserres)\> the updated user +**`Description`** + +updates a given user + #### Defined in -[medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/users.ts#L79) +[packages/medusa-js/src/resources/admin/users.ts:79](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/users.ts#L79) diff --git a/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md b/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md index 0227e00058..eb2502c2be 100644 --- a/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md +++ b/www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminVariantsResource ## Hierarchy @@ -8,21 +12,72 @@ ## Methods -### list +### getInventory -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> +▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\> #### Parameters -| Name | Type | -| :------ | :------ | -| `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | id of the variant to fetch inventory for | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\> #### Defined in -[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/variants.ts#L7) +[packages/medusa-js/src/resources/admin/variants.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L60) + +___ + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\> + +List product variants + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`AdminGetVariantsParams`](internal-8.internal.AdminGetVariantsParams.md) | Query to filter variants by | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\> + +A list of variants satisfying the criteria of the query + +#### Defined in + +[packages/medusa-js/src/resources/admin/variants.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L19) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\> + +Get a product variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | Query to filter variants by | +| `query?` | [`AdminGetVariantParams`](internal-8.internal.AdminGetVariantParams.md) | - | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\> + +A list of variants satisfying the criteria of the query + +#### Defined in + +[packages/medusa-js/src/resources/admin/variants.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L39) diff --git a/www/apps/docs/content/references/js-client/classes/AuthResource.md b/www/apps/docs/content/references/js-client/classes/AuthResource.md index e70a7e55f0..b21cbf2415 100644 --- a/www/apps/docs/content/references/js-client/classes/AuthResource.md +++ b/www/apps/docs/content/references/js-client/classes/AuthResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AuthResource ## Hierarchy @@ -10,97 +14,122 @@ ### authenticate -▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> - -**`Description`** - -Authenticates a customer using email and password combination +▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostAuthReq`](internal-34.StorePostAuthReq.md) | authentication payload | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | authentication payload | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> + +**`Description`** + +Authenticates a customer using email and password combination #### Defined in -[medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L16) +[packages/medusa-js/src/resources/auth.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L18) ___ ### deleteSession -▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> - -**`Description`** - -Removes authentication session +▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<`void`\> + +**`Description`** + +Removes authentication session #### Defined in -[medusa-js/src/resources/auth.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L25) +[packages/medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L27) ___ ### exists -▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> - -**`Description`** - -Check if email exists +▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `email` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-34.md#storegetauthemailres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal-8.internal.md#storegetauthemailres)\> + +**`Description`** + +Check if email exists #### Defined in -[medusa-js/src/resources/auth.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L47) +[packages/medusa-js/src/resources/auth.ts:49](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L49) ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> +▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreAuthRes`](../modules/internal-8.internal.md#storeauthres)\> **`Description`** Retrieves an authenticated session Usually used to check if authenticated session is alive. +#### Defined in + +[packages/medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L38) + +___ + +### getToken + +▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreBearerAuthRes`](../modules/internal-8.internal.md#storebearerauthres)\> + #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePostAuthReq`](internal-8.internal.StorePostAuthReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal-34.md#storeauthres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreBearerAuthRes`](../modules/internal-8.internal.md#storebearerauthres)\> + +**`Description`** + +Retrieves a new JWT access token #### Defined in -[medusa-js/src/resources/auth.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/auth.ts#L36) +[packages/medusa-js/src/resources/auth.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/auth.ts#L60) diff --git a/www/apps/docs/content/references/js-client/classes/CartsResource.md b/www/apps/docs/content/references/js-client/classes/CartsResource.md index 79c72aaf35..e3eca47876 100644 --- a/www/apps/docs/content/references/js-client/classes/CartsResource.md +++ b/www/apps/docs/content/references/js-client/classes/CartsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: CartsResource ## Hierarchy @@ -14,13 +18,13 @@ #### Defined in -[medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L15) +[packages/medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L15) ## Methods ### addShippingMethod -▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Adds a shipping method to cart @@ -29,49 +33,49 @@ Adds a shipping method to cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | Id of cart | -| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-35.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartShippingMethodReq`](internal-8.internal.StorePostCartsCartShippingMethodReq.md) | Contains id of shipping option and optional data | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L24) +[packages/medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L24) ___ ### complete -▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.md#storecompletecartres)\> +▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-8.internal.md#storecompletecartres)\> Completes a cart. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. If payment is authorized and order is not yet created, we make sure to do so. The completion of a cart can be performed idempotently with a provided header Idempotency-Key. -If not provuided, we will generate one for the request. +If not provided, we will generate one for the request. #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-35.md#storecompletecartres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal-8.internal.md#storecompletecartres)\> #### Defined in -[medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L43) +[packages/medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L43) ___ ### create -▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Creates a cart @@ -79,22 +83,22 @@ Creates a cart | Name | Type | Description | | :------ | :------ | :------ | -| `payload?` | [`StorePostCartReq`](internal-35.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload?` | [`StorePostCartReq`](internal-8.internal.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L58) +[packages/medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L58) ___ ### createPaymentSessions -▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Creates payment sessions. Initializes the payment sessions that can be used to pay for the items of the cart. @@ -105,21 +109,21 @@ This is usually called when a customer proceeds to checkout. | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L74) +[packages/medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L74) ___ ### deleteDiscount -▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Removes a discount from cart. @@ -129,21 +133,21 @@ Removes a discount from cart. | :------ | :------ | :------ | | `cart_id` | `string` | is required | | `code` | `string` | discount code to remove | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L89) +[packages/medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L89) ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Removes a payment session from a cart. Can be useful in case a payment has failed @@ -154,21 +158,21 @@ Can be useful in case a payment has failed | :------ | :------ | :------ | | `cart_id` | `string` | is required | | `provider_id` | `string` | the provider id of the session e.g. "stripe" | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L106) +[packages/medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L106) ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Refreshes a payment session. @@ -178,21 +182,21 @@ Refreshes a payment session. | :------ | :------ | :------ | | `cart_id` | `string` | is required | | `provider_id` | `string` | the provider id of the session e.g. "stripe" | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L122) +[packages/medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L122) ___ ### retrieve -▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Retrieves a cart @@ -201,21 +205,21 @@ Retrieves a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L137) +[packages/medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L137) ___ ### setPaymentSession -▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Refreshes a payment session. @@ -224,22 +228,22 @@ Refreshes a payment session. | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-35.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal-8.internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L152) +[packages/medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L152) ___ ### update -▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Updates a cart @@ -248,22 +252,22 @@ Updates a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `payload` | [`StorePostCartsCartReq`](internal-35.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartReq`](internal-8.internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L168) +[packages/medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L168) ___ ### updatePaymentSession -▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Updates the payment method @@ -273,13 +277,13 @@ Updates the payment method | :------ | :------ | :------ | | `cart_id` | `string` | is required | | `provider_id` | `string` | is required | -| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-35.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/carts.ts#L185) +[packages/medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/carts.ts#L185) diff --git a/www/apps/docs/content/references/js-client/classes/CollectionsResource.md b/www/apps/docs/content/references/js-client/classes/CollectionsResource.md index d4fb8940d2..12697f9ef7 100644 --- a/www/apps/docs/content/references/js-client/classes/CollectionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/CollectionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: CollectionsResource ## Hierarchy @@ -10,48 +14,48 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> - -**`Description`** - -Retrieves a list of collections +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetCollectionsParams`](internal-36.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`StoreGetCollectionsParams`](internal-8.internal.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-36.md#storecollectionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal-8.internal.md#storecollectionslistres)\> + +**`Description`** + +Retrieves a list of collections #### Defined in -[medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/collections.ts#L28) +[packages/medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/collections.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> - -**`Description`** - -Retrieves a single collection +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | id of the collection | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-36.md#storecollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal-8.internal.md#storecollectionsres)\> + +**`Description`** + +Retrieves a single collection #### Defined in -[medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/collections.ts#L17) +[packages/medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/collections.ts#L17) diff --git a/www/apps/docs/content/references/js-client/classes/CustomerResource.md b/www/apps/docs/content/references/js-client/classes/CustomerResource.md index ac2ae94cea..b3bb813c85 100644 --- a/www/apps/docs/content/references/js-client/classes/CustomerResource.md +++ b/www/apps/docs/content/references/js-client/classes/CustomerResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: CustomerResource ## Hierarchy @@ -14,7 +18,7 @@ #### Defined in -[medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L18) +[packages/medusa-js/src/resources/customers.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L18) ___ @@ -24,13 +28,13 @@ ___ #### Defined in -[medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L17) +[packages/medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L17) ## Methods ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Creates a customer @@ -38,22 +42,22 @@ Creates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersReq`](internal-37.StorePostCustomersReq.md) | information of customer | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCustomersReq`](internal-8.internal.StorePostCustomersReq.md) | information of customer | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L26) +[packages/medusa-js/src/resources/customers.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L26) ___ ### generatePasswordToken -▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) Generates a reset password token, which can be used to reset the password. The token is not returned but should be sent out to the customer in an email. @@ -62,22 +66,22 @@ The token is not returned but should be sent out to the customer in an email. | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-37.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Defined in -[medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L101) +[packages/medusa-js/src/resources/customers.ts:101](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L101) ___ ### listOrders -▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> +▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\> Retrieve customer orders @@ -85,22 +89,22 @@ Retrieve customer orders | Name | Type | Description | | :------ | :------ | :------ | -| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-37.md#storecustomerslistordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal-8.internal.md#storecustomerslistordersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L66) +[packages/medusa-js/src/resources/customers.ts:66](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L66) ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Resets customer password @@ -108,22 +112,22 @@ Resets customer password | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersResetPasswordReq`](internal-37.StorePostCustomersResetPasswordReq.md) | info used to reset customer password | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCustomersResetPasswordReq`](internal-8.internal.StorePostCustomersResetPasswordReq.md) | info used to reset customer password | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L86) +[packages/medusa-js/src/resources/customers.ts:86](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L86) ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Retrieves the customer that is currently logged @@ -131,21 +135,21 @@ Retrieves the customer that is currently logged | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L39) +[packages/medusa-js/src/resources/customers.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L39) ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> Updates a customer @@ -153,13 +157,13 @@ Updates a customer | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerReq`](internal-37.StorePostCustomersCustomerReq.md) | information to update customer with | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCustomersCustomerReq`](internal-8.internal.StorePostCustomersCustomerReq.md) | information to update customer with | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersRes`](../modules/internal-8.internal.md#storecustomersres)\> #### Defined in -[medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/customers.ts#L52) +[packages/medusa-js/src/resources/customers.ts:52](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/customers.ts#L52) diff --git a/www/apps/docs/content/references/js-client/classes/GiftCardsResource.md b/www/apps/docs/content/references/js-client/classes/GiftCardsResource.md index f044046721..ef025cbbae 100644 --- a/www/apps/docs/content/references/js-client/classes/GiftCardsResource.md +++ b/www/apps/docs/content/references/js-client/classes/GiftCardsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: GiftCardsResource ## Hierarchy @@ -10,23 +14,23 @@ ### retrieve -▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> - -**`Description`** - -Retrieves a single GiftCard +▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `code` | `string` | code of the gift card | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-38.md#storegiftcardsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal-8.internal.md#storegiftcardsres)\> + +**`Description`** + +Retrieves a single GiftCard #### Defined in -[medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/gift-cards.ts#L12) +[packages/medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/gift-cards.ts#L12) diff --git a/www/apps/docs/content/references/js-client/classes/LineItemsResource.md b/www/apps/docs/content/references/js-client/classes/LineItemsResource.md index 2e45601e7b..d3a7be1564 100644 --- a/www/apps/docs/content/references/js-client/classes/LineItemsResource.md +++ b/www/apps/docs/content/references/js-client/classes/LineItemsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: LineItemsResource ## Hierarchy @@ -10,7 +14,7 @@ ### create -▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Creates a line-item for a cart @@ -19,22 +23,22 @@ Creates a line-item for a cart | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | -| `payload` | [`StorePostCartsCartLineItemsReq`](internal-39.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartLineItemsReq`](internal-8.internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L17) +[packages/medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/line-items.ts#L17) ___ ### delete -▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Remove a line-item from a cart @@ -44,21 +48,21 @@ Remove a line-item from a cart | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | | `line_id` | `string` | id of item to remove | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L50) +[packages/medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/line-items.ts#L50) ___ ### update -▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> Updates a line-item. Only quantity updates are allowed @@ -69,13 +73,13 @@ Only quantity updates are allowed | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | | `line_id` | `string` | id of item to update | -| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-39.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal-8.internal.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal-35.md#storecartsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCartsRes`](../modules/internal-8.internal.md#storecartsres)\> #### Defined in -[medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/line-items.ts#L34) +[packages/medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/line-items.ts#L34) diff --git a/www/apps/docs/content/references/js-client/classes/OrderEditsResource.md b/www/apps/docs/content/references/js-client/classes/OrderEditsResource.md index b161f8ed16..f897747cb8 100644 --- a/www/apps/docs/content/references/js-client/classes/OrderEditsResource.md +++ b/www/apps/docs/content/references/js-client/classes/OrderEditsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: OrderEditsResource ## Hierarchy @@ -17,7 +21,7 @@ | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns @@ -25,7 +29,7 @@ #### Defined in -[medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L26) +[packages/medusa-js/src/resources/order-edits.ts:26](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L26) ___ @@ -38,8 +42,8 @@ ___ | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-40.StorePostOrderEditsOrderEditDecline.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePostOrderEditsOrderEditDecline`](internal-8.internal.StorePostOrderEditsOrderEditDecline.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns @@ -47,25 +51,25 @@ ___ #### Defined in -[medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L17) +[packages/medusa-js/src/resources/order-edits.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L17) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-40.md#storeordereditsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrderEditsRes`](../modules/internal-8.internal.md#storeordereditsres)\> #### Defined in -[medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/order-edits.ts#L9) +[packages/medusa-js/src/resources/order-edits.ts:9](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/order-edits.ts#L9) diff --git a/www/apps/docs/content/references/js-client/classes/OrdersResource.md b/www/apps/docs/content/references/js-client/classes/OrdersResource.md index fc2b0d0739..5bb2fa1490 100644 --- a/www/apps/docs/content/references/js-client/classes/OrdersResource.md +++ b/www/apps/docs/content/references/js-client/classes/OrdersResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: OrdersResource ## Hierarchy @@ -10,123 +14,123 @@ ### confirmRequest -▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StorePostCustomersCustomerAcceptClaimReq`](internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md) | signed token to grant access | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise) **`Description`** Grant access to a list of orders -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerAcceptClaimReq`](internal-41.StorePostCustomersCustomerAcceptClaimReq.md) | signed token to grant access | -| `customHeaders` | `Record`<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> - #### Defined in -[medusa-js/src/resources/orders.ts:78](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L78) +[packages/medusa-js/src/resources/orders.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L78) ___ ### lookupOrder -▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> +▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`StoreGetOrdersParams`](internal-8.internal.StoreGetOrdersParams.md) | details used to look up the order | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> **`Description`** Look up an order using order details -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `payload` | [`StoreGetOrdersParams`](internal-41.StoreGetOrdersParams.md) | details used to look up the order | -| `customHeaders` | `Record`<`string`, `any`\> | | - -#### Returns - -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> - #### Defined in -[medusa-js/src/resources/orders.ts:46](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L46) +[packages/medusa-js/src/resources/orders.ts:46](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L46) ___ ### requestCustomerOrders -▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> - -**`Description`** - -Request access to a list of orders +▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise) #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-41.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostCustomersCustomerOrderClaimReq`](internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md) | display ids of orders to request | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise) + +**`Description`** + +Request access to a list of orders #### Defined in -[medusa-js/src/resources/orders.ts:64](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L64) +[packages/medusa-js/src/resources/orders.ts:64](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L64) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> - -**`Description`** - -Retrieves an order +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> + +**`Description`** + +Retrieves an order #### Defined in -[medusa-js/src/resources/orders.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L18) +[packages/medusa-js/src/resources/orders.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L18) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> - -**`Description`** - -Retrieves an order by cart id +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-41.md#storeordersres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreOrdersRes`](../modules/internal-8.internal.md#storeordersres)\> + +**`Description`** + +Retrieves an order by cart id #### Defined in -[medusa-js/src/resources/orders.ts:32](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/orders.ts#L32) +[packages/medusa-js/src/resources/orders.ts:32](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/orders.ts#L32) diff --git a/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md b/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md index bc6996bc76..08f2373787 100644 --- a/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: PaymentCollectionsResource ## Hierarchy @@ -10,7 +14,7 @@ ### authorizePaymentSession -▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Parameters @@ -18,87 +22,87 @@ | :------ | :------ | | `id` | `string` | | `session_id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:29](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L29) +[packages/medusa-js/src/resources/payment-collections.ts:29](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L29) ___ ### authorizePaymentSessionsBatch -▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePostPaymentCollectionsBatchSessionsAuthorizeReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:38](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L38) +[packages/medusa-js/src/resources/payment-collections.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L38) ___ ### managePaymentSession -▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`StorePaymentCollectionSessionsReq`](internal-42.StorePaymentCollectionSessionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePaymentCollectionSessionsReq`](internal-8.internal.StorePaymentCollectionSessionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:56](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L56) +[packages/medusa-js/src/resources/payment-collections.ts:56](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L56) ___ ### managePaymentSessionsBatch -▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-42.StorePostPaymentCollectionsBatchSessionsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePostPaymentCollectionsBatchSessionsReq`](internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L47) +[packages/medusa-js/src/resources/payment-collections.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L47) ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-42.md#storepaymentcollectionssessionres)\> +▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\> #### Parameters @@ -106,34 +110,34 @@ ___ | :------ | :------ | | `id` | `string` | | `session_id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-42.md#storepaymentcollectionssessionres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsSessionRes`](../modules/internal-8.internal.md#storepaymentcollectionssessionres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:65](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L65) +[packages/medusa-js/src/resources/payment-collections.ts:65](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L65) ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Parameters | Name | Type | | :------ | :------ | | `id` | `string` | -| `query?` | [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`StoreGetPaymentCollectionsParams`](internal-8.internal.StoreGetPaymentCollectionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-42.md#storepaymentcollectionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePaymentCollectionsRes`](../modules/internal-8.internal.md#storepaymentcollectionsres)\> #### Defined in -[medusa-js/src/resources/payment-collections.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-collections.ts#L14) +[packages/medusa-js/src/resources/payment-collections.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-collections.ts#L14) diff --git a/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md b/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md index 7778e025ce..52fddb50fa 100644 --- a/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md +++ b/www/apps/docs/content/references/js-client/classes/PaymentMethodsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: PaymentMethodsResource ## Hierarchy @@ -10,7 +14,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\> Lists customer payment methods @@ -18,12 +22,12 @@ Lists customer payment methods | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-43.md#storecustomerslistpaymentmethodsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal-8.internal.md#storecustomerslistpaymentmethodsres)\> #### Defined in -[medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/payment-methods.ts#L12) +[packages/medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/payment-methods.ts#L12) diff --git a/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md new file mode 100644 index 0000000000..0adee3adc5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/ProductCategoriesResource.md @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCategoriesResource + +## Hierarchy + +- `default` + + ↳ **`ProductCategoriesResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesRes`](../modules/internal-8.internal.md#storegetproductcategoriesres)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`StoreGetProductCategoriesParams`](internal-8.internal.StoreGetProductCategoriesParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesRes`](../modules/internal-8.internal.md#storegetproductcategoriesres)\> + +**`Description`** + +Retrieves a list of product categories + +#### Defined in + +[packages/medusa-js/src/resources/product-categories.ts:40](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-categories.ts#L40) + +___ + +### retrieve + +▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../modules/internal-8.internal.md#storegetproductcategoriescategoryres)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the product category | +| `query?` | [`StoreGetProductCategoriesCategoryParams`](internal-8.internal.StoreGetProductCategoriesCategoryParams.md) | is optional. Can contain a fields or relations for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../modules/internal-8.internal.md#storegetproductcategoriescategoryres)\> + +**`Description`** + +Retrieves a single product category + +#### Defined in + +[packages/medusa-js/src/resources/product-categories.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-categories.ts#L19) diff --git a/www/apps/docs/content/references/js-client/classes/ProductTagsResource.md b/www/apps/docs/content/references/js-client/classes/ProductTagsResource.md new file mode 100644 index 0000000000..b5698b7ff8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/ProductTagsResource.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTagsResource + +## Hierarchy + +- `default` + + ↳ **`ProductTagsResource`** + +## Methods + +### list + +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTagsListRes`](../modules/internal-8.internal.md#storeproducttagslistres)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `query?` | [`StoreGetProductTagsParams`](internal-8.internal.StoreGetProductTagsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | + +#### Returns + +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTagsListRes`](../modules/internal-8.internal.md#storeproducttagslistres)\> + +**`Description`** + +Retrieves a list of product tags + +#### Defined in + +[packages/medusa-js/src/resources/product-tags.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-tags.ts#L16) diff --git a/www/apps/docs/content/references/js-client/classes/ProductTypesResource.md b/www/apps/docs/content/references/js-client/classes/ProductTypesResource.md index 54565bf891..c32768ea11 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductTypesResource.md +++ b/www/apps/docs/content/references/js-client/classes/ProductTypesResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ProductTypesResource ## Hierarchy @@ -10,23 +14,23 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> - -**`Description`** - -Retrieves a list of product types +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`StoreGetProductTypesParams`](internal-8.internal.StoreGetProductTypesParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-44.md#storeproducttypeslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductTypesListRes`](../modules/internal-8.internal.md#storeproducttypeslistres)\> + +**`Description`** + +Retrieves a list of product types #### Defined in -[medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-types.ts#L16) +[packages/medusa-js/src/resources/product-types.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-types.ts#L16) diff --git a/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md b/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md index 219fd087a8..92df80056f 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md +++ b/www/apps/docs/content/references/js-client/classes/ProductVariantsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ProductVariantsResource ## Hierarchy @@ -10,48 +14,48 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> - -**`Description`** - -Retrieves a list of of Product Variants +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`StoreGetVariantsParams`](internal-8.internal.StoreGetVariantsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-45.md#storevariantslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal-8.internal.md#storevariantslistres)\> + +**`Description`** + +Retrieves a list of of Product Variants #### Defined in -[medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-variants.ts#L28) +[packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-variants.ts#L28) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> - -**`Description`** - -Retrieves a single product variant +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-45.md#storevariantsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreVariantsRes`](../modules/internal-8.internal.md#storevariantsres)\> + +**`Description`** + +Retrieves a single product variant #### Defined in -[medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/product-variants.ts#L17) +[packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/product-variants.ts#L17) diff --git a/www/apps/docs/content/references/js-client/classes/ProductsResource.md b/www/apps/docs/content/references/js-client/classes/ProductsResource.md index 7f8d5ba56f..b0752f4cc9 100644 --- a/www/apps/docs/content/references/js-client/classes/ProductsResource.md +++ b/www/apps/docs/content/references/js-client/classes/ProductsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ProductsResource ## Hierarchy @@ -14,79 +18,79 @@ #### Defined in -[medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L14) +[packages/medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L14) ## Methods ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> - -**`Description`** - -Retrieves a list of products +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `query?` | [`StoreGetProductsParams`](internal-46.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `query?` | [`StoreGetProductsParams`](internal-8.internal.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-46.md#storeproductslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsListRes`](../modules/internal-8.internal.md#storeproductslistres)\> + +**`Description`** + +Retrieves a list of products #### Defined in -[medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L50) +[packages/medusa-js/src/resources/products.ts:50](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L50) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> - -**`Description`** - -Retrieves a single Product +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal-46.md#storeproductsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreProductsRes`](../modules/internal-8.internal.md#storeproductsres)\> + +**`Description`** + +Retrieves a single Product #### Defined in -[medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L22) +[packages/medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L22) ___ ### search -▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> - -**`Description`** - -Searches for products +▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | -| `searchOptions` | [`StorePostSearchReq`](internal-46.StorePostSearchReq.md) | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `searchOptions` | [`StorePostSearchReq`](internal-8.internal.StorePostSearchReq.md) | is required | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-46.md#storepostsearchres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StorePostSearchRes`](../modules/internal-8.internal.md#storepostsearchres)\> + +**`Description`** + +Searches for products #### Defined in -[medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/products.ts#L36) +[packages/medusa-js/src/resources/products.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/products.ts#L36) diff --git a/www/apps/docs/content/references/js-client/classes/RegionsResource.md b/www/apps/docs/content/references/js-client/classes/RegionsResource.md index ca20a5ad90..2bbd41178c 100644 --- a/www/apps/docs/content/references/js-client/classes/RegionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/RegionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: RegionsResource ## Hierarchy @@ -10,47 +14,47 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> - -**`Description`** - -Retrieves a list of regions +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-47.md#storeregionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal-8.internal.md#storeregionslistres)\> + +**`Description`** + +Retrieves a list of regions #### Defined in -[medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/regions.ts#L11) +[packages/medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/regions.ts#L11) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> - -**`Description`** - -Retrieves a region +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-47.md#storeregionsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreRegionsRes`](../modules/internal-8.internal.md#storeregionsres)\> + +**`Description`** + +Retrieves a region #### Defined in -[medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/regions.ts#L22) +[packages/medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/regions.ts#L22) diff --git a/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md b/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md index d0d5047e86..ac04755ac9 100644 --- a/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md +++ b/www/apps/docs/content/references/js-client/classes/ReturnReasonsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ReturnReasonsResource ## Hierarchy @@ -10,7 +14,7 @@ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.md#storereturnreasonslistres)\> +▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\> Lists return reasons defined in Medusa Admin @@ -18,37 +22,37 @@ Lists return reasons defined in Medusa Admin | Name | Type | | :------ | :------ | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-48.md#storereturnreasonslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal-8.internal.md#storereturnreasonslistres)\> #### Defined in -[medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/return-reasons.ts#L25) +[packages/medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/return-reasons.ts#L25) ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> - -**`Description`** - -Retrieves a single Return Reason +▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | is required | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-48.md#storereturnreasonsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal-8.internal.md#storereturnreasonsres)\> + +**`Description`** + +Retrieves a single Return Reason #### Defined in -[medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/return-reasons.ts#L15) +[packages/medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/return-reasons.ts#L15) diff --git a/www/apps/docs/content/references/js-client/classes/ReturnsResource.md b/www/apps/docs/content/references/js-client/classes/ReturnsResource.md index 4e9ebccff8..03724bf3ae 100644 --- a/www/apps/docs/content/references/js-client/classes/ReturnsResource.md +++ b/www/apps/docs/content/references/js-client/classes/ReturnsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ReturnsResource ## Hierarchy @@ -10,7 +14,7 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\> Creates a return request @@ -18,13 +22,13 @@ Creates a return request | Name | Type | Description | | :------ | :------ | :------ | -| `payload` | [`StorePostReturnsReq`](internal-49.StorePostReturnsReq.md) | details needed to create a return | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `payload` | [`StorePostReturnsReq`](internal-8.internal.StorePostReturnsReq.md) | details needed to create a return | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-49.md#storereturnsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreReturnsRes`](../modules/internal-8.internal.md#storereturnsres)\> #### Defined in -[medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/returns.ts#L12) +[packages/medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/returns.ts#L12) diff --git a/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md b/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md index 19d2e7b0ba..68071ca9ac 100644 --- a/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md +++ b/www/apps/docs/content/references/js-client/classes/ShippingOptionsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ShippingOptionsResource ## Hierarchy @@ -10,48 +14,48 @@ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> - -**`Description`** - -Lists shiping options available +▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> #### Parameters | Name | Type | | :------ | :------ | -| `query?` | [`StoreGetShippingOptionsParams`](internal-50.StoreGetShippingOptionsParams.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `query?` | [`StoreGetShippingOptionsParams`](internal-8.internal.StoreGetShippingOptionsParams.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> + +**`Description`** + +Lists shipping options available #### Defined in -[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/shipping-options.ts#L27) +[packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/shipping-options.ts#L27) ___ ### listCartOptions -▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> - -**`Description`** - -Lists shiping options available for a cart +▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> #### Parameters | Name | Type | | :------ | :------ | | `cart_id` | `string` | -| `customHeaders` | `Record`<`string`, `any`\> | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-50.md#storeshippingoptionslistres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-8.internal.md#storeshippingoptionslistres)\> + +**`Description`** + +Lists shipping options available for a cart #### Defined in -[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/shipping-options.ts#L16) +[packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/shipping-options.ts#L16) diff --git a/www/apps/docs/content/references/js-client/classes/SwapsResource.md b/www/apps/docs/content/references/js-client/classes/SwapsResource.md index f7a60c1d14..5072c642f6 100644 --- a/www/apps/docs/content/references/js-client/classes/SwapsResource.md +++ b/www/apps/docs/content/references/js-client/classes/SwapsResource.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: SwapsResource ## Hierarchy @@ -10,48 +14,48 @@ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> - -**`Description`** - -Creates a swap from a cart +▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> #### Parameters | Name | Type | | :------ | :------ | -| `payload` | [`StorePostSwapsReq`](internal-51.StorePostSwapsReq.md) | -| `customHeaders` | `Record`<`string`, `any`\> | +| `payload` | [`StorePostSwapsReq`](internal-8.internal.StorePostSwapsReq.md) | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> + +**`Description`** + +Creates a swap from a cart #### Defined in -[medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L12) +[packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L12) ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> - -**`Description`** - -Retrieves a swap by cart id +▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `cart_id` | `string` | id of cart | -| `customHeaders` | `Record`<`string`, `any`\> | | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | | #### Returns -[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-51.md#storeswapsres)\> +[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`StoreSwapsRes`](../modules/internal-8.internal.md#storeswapsres)\> + +**`Description`** + +Retrieves a swap by cart id #### Defined in -[medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/swaps.ts#L23) +[packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/swaps.ts#L23) diff --git a/www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md b/www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md index d33e26f840..26a7db6e0e 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-1.AdminPostAuthReq.md @@ -1,7 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostAuthReq [internal](../modules/internal-1.md).AdminPostAuthReq +**`Schema`** + +AdminPostAuthReq +type: object +required: + - email + - password +properties: + email: + type: string + description: The user's email. + format: email + password: + type: string + description: The user's password. + format: password + ## Properties ### email @@ -10,7 +31,7 @@ #### Defined in -medusa/dist/api/routes/admin/auth/create-session.d.ts:76 +packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:78 ___ @@ -20,4 +41,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/auth/create-session.d.ts:77 +packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md b/www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md new file mode 100644 index 0000000000..da80bb34f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-1.BaseEntity.md @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: BaseEntity + +[internal](../modules/internal-1.md).BaseEntity + +Base abstract entity for all entities + +## Hierarchy + +- **`BaseEntity`** + + ↳ [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ [`ProductCategory`](internal-3.ProductCategory.md) + + ↳ [`TaxRate`](internal-3.TaxRate.md) + + ↳ [`Order`](internal-3.Order.md) + + ↳ [`Payment`](internal-3.Payment.md) + + ↳ [`Fulfillment`](internal-3.Fulfillment.md) + + ↳ [`Return`](internal-3.Return.md) + + ↳ [`Refund`](internal-3.Refund.md) + + ↳ [`DraftOrder`](internal-3.DraftOrder.md) + + ↳ [`OrderEdit`](internal-3.OrderEdit.md) + + ↳ [`LineItem`](internal-3.LineItem.md) + + ↳ [`PaymentSession`](internal-3.PaymentSession.md) + + ↳ [`TaxLine`](internal-3.TaxLine.md) + + ↳ [`Notification`](internal-8.internal.Notification.md) + + ↳ [`PublishableApiKey`](internal-8.internal.PublishableApiKey.md) + + ↳ [`Store`](internal-8.internal.Store.md) + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md b/www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md new file mode 100644 index 0000000000..f2b17568f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-1.SoftDeletableEntity.md @@ -0,0 +1,147 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SoftDeletableEntity + +[internal](../modules/internal-1.md).SoftDeletableEntity + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`SoftDeletableEntity`** + + ↳↳ [`User`](internal-1.User.md) + + ↳↳ [`BatchJob`](internal-2.BatchJob.md) + + ↳↳ [`ProductCollection`](internal-3.ProductCollection.md) + + ↳↳ [`Product`](internal-3.Product.md) + + ↳↳ [`Image`](internal-3.Image.md) + + ↳↳ [`ProductOption`](internal-3.ProductOption.md) + + ↳↳ [`ProductVariant`](internal-3.ProductVariant.md) + + ↳↳ [`ShippingProfile`](internal-3.ShippingProfile.md) + + ↳↳ [`ProductType`](internal-3.ProductType.md) + + ↳↳ [`ProductTag`](internal-3.ProductTag.md) + + ↳↳ [`SalesChannel`](internal-3.SalesChannel.md) + + ↳↳ [`ProductOptionValue`](internal-3.ProductOptionValue.md) + + ↳↳ [`MoneyAmount`](internal-3.MoneyAmount.md) + + ↳↳ [`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md) + + ↳↳ [`ShippingOption`](internal-3.ShippingOption.md) + + ↳↳ [`SalesChannelLocation`](internal-3.SalesChannelLocation.md) + + ↳↳ [`PriceList`](internal-3.PriceList.md) + + ↳↳ [`Region`](internal-3.Region.md) + + ↳↳ [`CustomerGroup`](internal-3.CustomerGroup.md) + + ↳↳ [`Customer`](internal-3.Customer.md) + + ↳↳ [`Address`](internal-3.Address.md) + + ↳↳ [`Cart`](internal-3.Cart.md) + + ↳↳ [`Discount`](internal-3.Discount.md) + + ↳↳ [`GiftCard`](internal-3.GiftCard.md) + + ↳↳ [`ClaimOrder`](internal-3.ClaimOrder.md) + + ↳↳ [`Swap`](internal-3.Swap.md) + + ↳↳ [`DiscountRule`](internal-3.DiscountRule.md) + + ↳↳ [`TrackingLink`](internal-3.TrackingLink.md) + + ↳↳ [`ClaimItem`](internal-3.ClaimItem.md) + + ↳↳ [`OrderItemChange`](internal-3.OrderItemChange.md) + + ↳↳ [`PaymentCollection`](internal-3.PaymentCollection.md) + + ↳↳ [`DiscountCondition`](internal-3.DiscountCondition.md) + + ↳↳ [`ReturnReason`](internal-3.ReturnReason.md) + + ↳↳ [`ClaimImage`](internal-3.ClaimImage.md) + + ↳↳ [`ClaimTag`](internal-3.ClaimTag.md) + + ↳↳ [`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md) + + ↳↳ [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md) + + ↳↳ [`Invite`](internal-8.internal.Invite.md) + + ↳↳ [`Note`](internal-8.internal.Note.md) + + ↳↳ [`ProductVariantMoneyAmount`](internal-8.internal.ProductVariantMoneyAmount.md) + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-1.User.md b/www/apps/docs/content/references/js-client/classes/internal-1.User.md index 3762203aca..56f6028958 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-1.User.md +++ b/www/apps/docs/content/references/js-client/classes/internal-1.User.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: User [internal](../modules/internal-1.md).User @@ -6,7 +10,7 @@ Base abstract entity for all entities ## Hierarchy -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) ↳ **`User`** @@ -18,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/user.d.ts:13 +packages/medusa/dist/models/user.d.ts:13 ___ @@ -28,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:15 +packages/medusa/dist/models/user.d.ts:15 ___ @@ -38,11 +42,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:6 +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -52,11 +56,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) #### Defined in -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -66,7 +70,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:9 +packages/medusa/dist/models/user.d.ts:9 ___ @@ -76,7 +80,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:10 +packages/medusa/dist/models/user.d.ts:10 ___ @@ -86,11 +90,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:5 +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -100,17 +104,17 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:11 +packages/medusa/dist/models/user.d.ts:11 ___ ### metadata -• **metadata**: `Record`<`string`, `unknown`\> +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/models/user.d.ts:14 +packages/medusa/dist/models/user.d.ts:14 ___ @@ -120,7 +124,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:12 +packages/medusa/dist/models/user.d.ts:12 ___ @@ -130,7 +134,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:8 +packages/medusa/dist/models/user.d.ts:8 ___ @@ -140,8 +144,8 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:7 +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md b/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md deleted file mode 100644 index 133fde0b39..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostInvitesInviteAcceptReq - -[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptReq - -## Properties - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:100 - -___ - -### user - -• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-10.AdminPostInvitesInviteAcceptUserReq.md) - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md b/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md deleted file mode 100644 index ece038ab37..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostInvitesInviteAcceptUserReq - -[internal](../modules/internal-10.md).AdminPostInvitesInviteAcceptUserReq - -## Properties - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:95 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:96 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/accept-invite.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md b/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md deleted file mode 100644 index 0bc3c29fce..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-10.AdminPostInvitesReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostInvitesReq - -[internal](../modules/internal-10.md).AdminPostInvitesReq - -## Properties - -### role - -• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) - -#### Defined in - -medusa/dist/api/routes/admin/invites/create-invite.d.ts:77 - -___ - -### user - -• **user**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/invites/create-invite.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-10.Invite.md b/www/apps/docs/content/references/js-client/classes/internal-10.Invite.md deleted file mode 100644 index 2058bf1433..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-10.Invite.md +++ /dev/null @@ -1,137 +0,0 @@ -# Class: Invite - -[internal](../modules/internal-10.md).Invite - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Invite`** - -## Properties - -### accepted - -• **accepted**: `boolean` - -#### Defined in - -medusa/dist/models/invite.d.ts:6 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/invite.d.ts:10 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### expires\_at - -• **expires\_at**: `Date` - -#### Defined in - -medusa/dist/models/invite.d.ts:8 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/invite.d.ts:9 - -___ - -### role - -• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) - -#### Defined in - -medusa/dist/models/invite.d.ts:5 - -___ - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/models/invite.d.ts:7 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### user\_email - -• **user\_email**: `string` - -#### Defined in - -medusa/dist/models/invite.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md b/www/apps/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md deleted file mode 100644 index 3f4178d604..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-11.AdminGetNotesParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminGetNotesParams - -[internal](../modules/internal-11.md).AdminGetNotesParams - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/notes/list-notes.d.ts:70 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/notes/list-notes.d.ts:71 - -___ - -### resource\_id - -• `Optional` **resource\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/list-notes.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md b/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md deleted file mode 100644 index 6a8c349f3f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesNoteReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostNotesNoteReq - -[internal](../modules/internal-11.md).AdminPostNotesNoteReq - -## Properties - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/update-note.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md b/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md deleted file mode 100644 index f15147baa8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-11.AdminPostNotesReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostNotesReq - -[internal](../modules/internal-11.md).AdminPostNotesReq - -## Properties - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/create-note.d.ts:84 - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/create-note.d.ts:85 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notes/create-note.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-11.Note.md b/www/apps/docs/content/references/js-client/classes/internal-11.Note.md deleted file mode 100644 index 7c87f94680..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-11.Note.md +++ /dev/null @@ -1,137 +0,0 @@ -# Class: Note - -[internal](../modules/internal-11.md).Note - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Note`** - -## Properties - -### author - -• **author**: [`User`](internal-1.User.md) - -#### Defined in - -medusa/dist/models/note.d.ts:8 - -___ - -### author\_id - -• **author\_id**: `string` - -#### Defined in - -medusa/dist/models/note.d.ts:7 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/note.d.ts:10 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/note.d.ts:9 - -___ - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -medusa/dist/models/note.d.ts:6 - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -medusa/dist/models/note.d.ts:5 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/note.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md deleted file mode 100644 index 1d4da95aa6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.AdminGetNotificationsParams.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminGetNotificationsParams - -[internal](../modules/internal-12.md).AdminGetNotificationsParams - -## Properties - -### event\_name - -• `Optional` **event\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:70 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:69 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:68 - -___ - -### include\_resends - -• `Optional` **include\_resends**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:74 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:66 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:67 - -___ - -### resource\_id - -• `Optional` **resource\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:72 - -___ - -### resource\_type - -• `Optional` **resource\_type**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:71 - -___ - -### to - -• `Optional` **to**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md b/www/apps/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md deleted file mode 100644 index 3b8965b6f2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.AdminPostNotificationsNotificationResendReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostNotificationsNotificationResendReq - -[internal](../modules/internal-12.md).AdminPostNotificationsNotificationResendReq - -## Properties - -### to - -• `Optional` **to**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:65 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Axios.md b/www/apps/docs/content/references/js-client/classes/internal-12.Axios.md similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal.Axios.md rename to www/apps/docs/content/references/js-client/classes/internal-12.Axios.md index 4f4afefbb7..0706a570e4 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.Axios.md +++ b/www/apps/docs/content/references/js-client/classes/internal-12.Axios.md @@ -4,23 +4,23 @@ displayed_sidebar: jsClientSidebar # Class: Axios -[internal](../modules/internal.md).Axios +[internal](../modules/internal-12.md).Axios ## Hierarchy - **`Axios`** - ↳ [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) + ↳ [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md) ## Properties ### defaults -• **defaults**: [`AxiosDefaults`](../interfaces/internal.AxiosDefaults.md)<`any`\> +• **defaults**: [`AxiosDefaults`](../interfaces/internal-12.AxiosDefaults.md)<`any`\> #### Defined in -medusa-js/node_modules/axios/index.d.ts:171 +packages/medusa-js/node_modules/axios/index.d.ts:171 ___ @@ -32,12 +32,12 @@ ___ | Name | Type | | :------ | :------ | -| `request` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](../interfaces/internal.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`any`, `any`\>\> | +| `request` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<`AxiosRequestConfig`<`any`\>\> | +| `response` | [`AxiosInterceptorManager`](../interfaces/internal-12.AxiosInterceptorManager.md)<[`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`any`, `any`\>\> | #### Defined in -medusa-js/node_modules/axios/index.d.ts:172 +packages/medusa-js/node_modules/axios/index.d.ts:172 ## Methods @@ -50,7 +50,7 @@ medusa-js/node_modules/axios/index.d.ts:172 | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -58,7 +58,7 @@ medusa-js/node_modules/axios/index.d.ts:172 | Name | Type | | :------ | :------ | | `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -66,7 +66,7 @@ medusa-js/node_modules/axios/index.d.ts:172 #### Defined in -medusa-js/node_modules/axios/index.d.ts:179 +packages/medusa-js/node_modules/axios/index.d.ts:179 ___ @@ -79,7 +79,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -87,7 +87,7 @@ ___ | Name | Type | | :------ | :------ | | `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -95,7 +95,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:178 +packages/medusa-js/node_modules/axios/index.d.ts:178 ___ @@ -107,7 +107,7 @@ ___ | Name | Type | | :------ | :------ | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`any`\> | +| `config?` | `AxiosRequestConfig`<`any`\> | #### Returns @@ -115,7 +115,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:176 +packages/medusa-js/node_modules/axios/index.d.ts:176 ___ @@ -128,7 +128,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -136,7 +136,7 @@ ___ | Name | Type | | :------ | :------ | | `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -144,7 +144,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:180 +packages/medusa-js/node_modules/axios/index.d.ts:180 ___ @@ -157,7 +157,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -165,7 +165,7 @@ ___ | Name | Type | | :------ | :------ | | `url` | `string` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -173,7 +173,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:181 +packages/medusa-js/node_modules/axios/index.d.ts:181 ___ @@ -186,7 +186,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -195,7 +195,7 @@ ___ | :------ | :------ | | `url` | `string` | | `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -203,7 +203,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:184 +packages/medusa-js/node_modules/axios/index.d.ts:184 ___ @@ -216,7 +216,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -225,7 +225,7 @@ ___ | :------ | :------ | | `url` | `string` | | `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -233,7 +233,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:182 +packages/medusa-js/node_modules/axios/index.d.ts:182 ___ @@ -246,7 +246,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters @@ -255,7 +255,7 @@ ___ | :------ | :------ | | `url` | `string` | | `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config?` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -263,7 +263,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:183 +packages/medusa-js/node_modules/axios/index.d.ts:183 ___ @@ -276,14 +276,14 @@ ___ | Name | Type | | :------ | :------ | | `T` | `any` | -| `R` | [`AxiosResponse`](../interfaces/internal.AxiosResponse.md)<`T`, `any`\> | +| `R` | [`AxiosResponse`](../interfaces/internal-12.AxiosResponse.md)<`T`, `any`\> | | `D` | `any` | #### Parameters | Name | Type | | :------ | :------ | -| `config` | [`AxiosRequestConfig`](../interfaces/internal.AxiosRequestConfig.md)<`D`\> | +| `config` | `AxiosRequestConfig`<`D`\> | #### Returns @@ -291,4 +291,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:177 +packages/medusa-js/node_modules/axios/index.d.ts:177 diff --git a/www/apps/docs/content/references/js-client/classes/internal-12.Client.md b/www/apps/docs/content/references/js-client/classes/internal-12.Client.md new file mode 100644 index 0000000000..3ba34504e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-12.Client.md @@ -0,0 +1,186 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Client + +[internal](../modules/internal-12.md).Client + +## Properties + +### axiosClient + +• `Private` **axiosClient**: [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:36](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L36) + +___ + +### config + +• `Private` **config**: [`Config`](../interfaces/internal-12.Config.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L37) + +## Methods + +### createClient + +▸ **createClient**(`config`): [`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md) + +Creates the axios client used for requests +As part of the creation, we configure the retry conditions +and the exponential backoff approach. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`Config`](../interfaces/internal-12.Config.md) | user supplied configurations | + +#### Returns + +[`AxiosInstance`](../interfaces/internal-12.AxiosInstance.md) + +#### Defined in + +[packages/medusa-js/src/request.ts:169](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L169) + +___ + +### normalizeHeader + +▸ **normalizeHeader**(`header`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `header` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/medusa-js/src/request.ts:90](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L90) + +___ + +### normalizeHeaders + +▸ **normalizeHeaders**(`obj`): [`Record`](../modules/internal.md#record)<`string`, `any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `object` | + +#### Returns + +[`Record`](../modules/internal.md#record)<`string`, `any`\> + +#### Defined in + +[packages/medusa-js/src/request.ts:78](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L78) + +___ + +### request + +▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> + +Axios request + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `method` | [`RequestMethod`](../modules/internal-12.md#requestmethod) | request method | +| `path` | `string` | request path | +| `payload` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | request payload | +| `options` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | axios configuration | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom request headers | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/medusa-js/src/request.ts:206](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L206) + +___ + +### requiresAuthentication + +▸ **requiresAuthentication**(`path`, `method`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `any` | +| `method` | `any` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/medusa-js/src/request.ts:99](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L99) + +___ + +### setHeaders + +▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +Creates all the initial headers. +We add the idempotency key, if the request is configured to retry. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userHeaders` | [`RequestOptions`](../interfaces/internal-5.RequestOptions.md) | user supplied headers | +| `method` | [`RequestMethod`](../modules/internal-12.md#requestmethod) | request method | +| `path` | `string` | request path | +| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | user supplied headers | + +#### Returns + +[`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +[packages/medusa-js/src/request.ts:115](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L115) + +___ + +### shouldRetryCondition + +▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`AxiosError`](../interfaces/internal-12.AxiosError.md)<`any`, `any`\> | +| `numRetries` | `number` | +| `maxRetries` | `number` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/medusa-js/src/request.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L47) diff --git a/www/apps/docs/content/references/js-client/classes/internal-12.Notification.md b/www/apps/docs/content/references/js-client/classes/internal-12.Notification.md deleted file mode 100644 index 9719facba1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.Notification.md +++ /dev/null @@ -1,183 +0,0 @@ -# Class: Notification - -[internal](../modules/internal-12.md).Notification - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Notification`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/notification.d.ts:17 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customer - -• **customer**: [`Customer`](internal.Customer.md) - -#### Defined in - -medusa/dist/models/notification.d.ts:9 - -___ - -### customer\_id - -• **customer\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:8 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/notification.d.ts:11 - -___ - -### event\_name - -• **event\_name**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:5 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### parent\_id - -• **parent\_id**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:12 - -___ - -### parent\_notification - -• **parent\_notification**: [`Notification`](internal-12.Notification.md) - -#### Defined in - -medusa/dist/models/notification.d.ts:13 - -___ - -### provider - -• **provider**: [`NotificationProvider`](internal-12.NotificationProvider.md) - -#### Defined in - -medusa/dist/models/notification.d.ts:16 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:15 - -___ - -### resends - -• **resends**: [`Notification`](internal-12.Notification.md)[] - -#### Defined in - -medusa/dist/models/notification.d.ts:14 - -___ - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:7 - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:6 - -___ - -### to - -• **to**: `string` - -#### Defined in - -medusa/dist/models/notification.d.ts:10 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-12.NotificationProvider.md b/www/apps/docs/content/references/js-client/classes/internal-12.NotificationProvider.md deleted file mode 100644 index cf8fa64584..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-12.NotificationProvider.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: NotificationProvider - -[internal](../modules/internal-12.md).NotificationProvider - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/models/notification-provider.d.ts:2 - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -medusa/dist/models/notification-provider.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md deleted file mode 100644 index 77846d28cf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostOrderEditsEditLineItemsLineItemReq - -[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsLineItemReq - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md deleted file mode 100644 index 5dc51b19b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrderEditsEditLineItemsReq - -[internal](../modules/internal-13.md).AdminPostOrderEditsEditLineItemsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:82 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:81 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md b/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md deleted file mode 100644 index bd242ee1c2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsOrderEditReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostOrderEditsOrderEditReq - -[internal](../modules/internal-13.md).AdminPostOrderEditsOrderEditReq - -## Properties - -### internal\_note - -• `Optional` **internal\_note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md b/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md deleted file mode 100644 index 802f405149..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-13.AdminPostOrderEditsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostOrderEditsReq - -[internal](../modules/internal-13.md).AdminPostOrderEditsReq - -## Properties - -### internal\_note - -• `Optional` **internal\_note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:72 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsOrderEditParams.md b/www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsOrderEditParams.md deleted file mode 100644 index 03a656d03d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsOrderEditParams.md +++ /dev/null @@ -1,37 +0,0 @@ -# Class: GetOrderEditsOrderEditParams - -[internal](../modules/internal-13.md).GetOrderEditsOrderEditParams - -## Hierarchy - -- [`FindParams`](internal-5.FindParams.md) - - ↳ **`GetOrderEditsOrderEditParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) - -#### Defined in - -medusa/dist/types/common.d.ts:117 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) - -#### Defined in - -medusa/dist/types/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md deleted file mode 100644 index d52a95ccca..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem-1.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdditionalItem - -[internal](../modules/internal-14.md).AdditionalItem - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:206 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:205 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem.md deleted file mode 100644 index ae309e28c3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdditionalItem.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdditionalItem - -[internal](../modules/internal-14.md).AdditionalItem - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:170 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:169 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md deleted file mode 100644 index 5b8277937c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminGetOrdersParams.md +++ /dev/null @@ -1,273 +0,0 @@ -# Class: AdminGetOrdersParams - -[internal](../modules/internal-14.md).AdminGetOrdersParams - -## Hierarchy - -- [`AdminListOrdersSelector`](internal-14.AdminListOrdersSelector.md) - - ↳ **`AdminGetOrdersParams`** - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[canceled_at](internal-14.AdminListOrdersSelector.md#canceled_at) - -#### Defined in - -medusa/dist/types/orders.d.ts:93 - -___ - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[cart_id](internal-14.AdminListOrdersSelector.md#cart_id) - -#### Defined in - -medusa/dist/types/orders.d.ts:86 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[created_at](internal-14.AdminListOrdersSelector.md#created_at) - -#### Defined in - -medusa/dist/types/orders.d.ts:94 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[currency_code](internal-14.AdminListOrdersSelector.md#currency_code) - -#### Defined in - -medusa/dist/types/orders.d.ts:90 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[customer_id](internal-14.AdminListOrdersSelector.md#customer_id) - -#### Defined in - -medusa/dist/types/orders.d.ts:87 - -___ - -### display\_id - -• `Optional` **display\_id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[display_id](internal-14.AdminListOrdersSelector.md#display_id) - -#### Defined in - -medusa/dist/types/orders.d.ts:85 - -___ - -### email - -• `Optional` **email**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[email](internal-14.AdminListOrdersSelector.md#email) - -#### Defined in - -medusa/dist/types/orders.d.ts:88 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/list-orders.d.ts:209 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/list-orders.d.ts:210 - -___ - -### fulfillment\_status - -• `Optional` **fulfillment\_status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[fulfillment_status](internal-14.AdminListOrdersSelector.md#fulfillment_status) - -#### Defined in - -medusa/dist/types/orders.d.ts:83 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[id](internal-14.AdminListOrdersSelector.md#id) - -#### Defined in - -medusa/dist/types/orders.d.ts:81 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/list-orders.d.ts:208 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/list-orders.d.ts:207 - -___ - -### payment\_status - -• `Optional` **payment\_status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[payment_status](internal-14.AdminListOrdersSelector.md#payment_status) - -#### Defined in - -medusa/dist/types/orders.d.ts:84 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[q](internal-14.AdminListOrdersSelector.md#q) - -#### Defined in - -medusa/dist/types/orders.d.ts:80 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` \| `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[region_id](internal-14.AdminListOrdersSelector.md#region_id) - -#### Defined in - -medusa/dist/types/orders.d.ts:89 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[sales_channel_id](internal-14.AdminListOrdersSelector.md#sales_channel_id) - -#### Defined in - -medusa/dist/types/orders.d.ts:92 - -___ - -### status - -• `Optional` **status**: `string`[] - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[status](internal-14.AdminListOrdersSelector.md#status) - -#### Defined in - -medusa/dist/types/orders.d.ts:82 - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: `string` - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[tax_rate](internal-14.AdminListOrdersSelector.md#tax_rate) - -#### Defined in - -medusa/dist/types/orders.d.ts:91 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[AdminListOrdersSelector](internal-14.AdminListOrdersSelector.md).[updated_at](internal-14.AdminListOrdersSelector.md#updated_at) - -#### Defined in - -medusa/dist/types/orders.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md deleted file mode 100644 index f07cf4b132..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:69 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md deleted file mode 100644 index 493daaba98..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: AdminPostOrdersOrderClaimsClaimReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimReq - -## Properties - -### claim\_items - -• `Optional` **claim\_items**: [`Item`](internal-14.Item-2.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:145 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:148 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:147 - -___ - -### shipping\_methods - -• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-2.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:146 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md deleted file mode 100644 index 14f7fe659e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsClaimShipmentsReq - -## Properties - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:79 - -___ - -### tracking\_numbers - -• `Optional` **tracking\_numbers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md deleted file mode 100644 index 2fc47d1ed7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderClaimsReq.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminPostOrdersOrderClaimsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderClaimsReq - -## Properties - -### additional\_items - -• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:180 - -___ - -### claim\_items - -• **claim\_items**: [`Item`](internal-14.Item-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:178 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:185 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:184 - -___ - -### refund\_amount - -• `Optional` **refund\_amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:182 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-2.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:179 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:183 - -___ - -### shipping\_methods - -• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-14.ShippingMethod-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:181 - -___ - -### type - -• **type**: ``"refund"`` \| ``"replace"`` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:177 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md deleted file mode 100644 index 83639eae94..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrdersOrderFulfillmentsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderFulfillmentsReq - -## Properties - -### items - -• **items**: [`Item`](internal-14.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:100 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:102 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md deleted file mode 100644 index 3037fa33af..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderRefundsReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: AdminPostOrdersOrderRefundsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderRefundsReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:85 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:88 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:87 - -___ - -### reason - -• **reason**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/refund-payment.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md deleted file mode 100644 index b8a92e4ee1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReq.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: AdminPostOrdersOrderReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:131 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:136 - -___ - -### discounts - -• `Optional` **discounts**: `Record`<`string`, `unknown`\>[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:135 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:130 - -___ - -### items - -• `Optional` **items**: `Record`<`string`, `unknown`\>[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:133 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:139 - -___ - -### payment\_method - -• `Optional` **payment\_method**: [`PaymentMethod`](internal-14.PaymentMethod.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:137 - -___ - -### region - -• `Optional` **region**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:134 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:132 - -___ - -### shipping\_method - -• `Optional` **shipping\_method**: [`ShippingMethod`](internal-14.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:138 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md deleted file mode 100644 index dbceebf080..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderReturnsReq.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: AdminPostOrdersOrderReturnsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderReturnsReq - -## Properties - -### items - -• **items**: [`OrdersReturnItem`](internal-14.OrdersReturnItem.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:125 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:129 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:127 - -___ - -### receive\_now - -• `Optional` **receive\_now**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:128 - -___ - -### refund - -• `Optional` **refund**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:130 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:126 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md deleted file mode 100644 index 7be2b882b4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShipmentReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrdersOrderShipmentReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderShipmentReq - -## Properties - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:81 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:83 - -___ - -### tracking\_numbers - -• `Optional` **tracking\_numbers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-shipment.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md deleted file mode 100644 index b1865a689b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrdersOrderShippingMethodsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderShippingMethodsReq - -## Properties - -### data - -• `Optional` **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:69 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:68 - -___ - -### price - -• **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:67 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md deleted file mode 100644 index 27b76027e0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsReq.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: AdminPostOrdersOrderSwapsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsReq - -## Properties - -### additional\_items - -• `Optional` **additional\_items**: [`AdditionalItem`](internal-14.AdditionalItem.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:149 - -___ - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:152 - -___ - -### custom\_shipping\_options - -• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-14.CustomShippingOption.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:150 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:151 - -___ - -### return\_items - -• **return\_items**: [`ReturnItem`](internal-14.ReturnItem.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:147 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-14.ReturnShipping-1.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:148 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md deleted file mode 100644 index b46a804808..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:69 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md deleted file mode 100644 index 07298bca47..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq - -[internal](../modules/internal-14.md).AdminPostOrdersOrderSwapsSwapShipmentsReq - -## Properties - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:82 - -___ - -### no\_notification - -• `Optional` **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:84 - -___ - -### tracking\_numbers - -• `Optional` **tracking\_numbers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:83 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md b/www/apps/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md deleted file mode 100644 index 1c3467ab19..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.CustomShippingOption.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: CustomShippingOption - -[internal](../modules/internal-14.md).CustomShippingOption - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:165 - -___ - -### price - -• **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:166 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.Image.md b/www/apps/docs/content/references/js-client/classes/internal-14.Image.md deleted file mode 100644 index d137ceeced..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.Image.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Image - -[internal](../modules/internal-14.md).Image - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:164 - -___ - -### url - -• `Optional` **url**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:165 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.Item-1.md b/www/apps/docs/content/references/js-client/classes/internal-14.Item-1.md deleted file mode 100644 index 98fe14fe2f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.Item-1.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: Item - -[internal](../modules/internal-14.md).Item - -## Properties - -### images - -• `Optional` **images**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:202 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:197 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:199 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:198 - -___ - -### reason - -• `Optional` **reason**: [`ClaimReason`](../enums/internal.ClaimReason.md) - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:200 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:201 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.Item-2.md b/www/apps/docs/content/references/js-client/classes/internal-14.Item-2.md deleted file mode 100644 index d90a1aef2e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.Item-2.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: Item - -[internal](../modules/internal-14.md).Item - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:156 - -___ - -### images - -• **images**: [`Image`](internal-14.Image.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:159 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:161 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:157 - -___ - -### reason - -• `Optional` **reason**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:158 - -___ - -### tags - -• **tags**: [`Tag`](internal-14.Tag.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:160 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.Item.md b/www/apps/docs/content/references/js-client/classes/internal-14.Item.md deleted file mode 100644 index 8d1ee7082b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.Item.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Item - -[internal](../modules/internal-14.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:105 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.PaymentMethod.md b/www/apps/docs/content/references/js-client/classes/internal-14.PaymentMethod.md deleted file mode 100644 index a4e0fc3012..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.PaymentMethod.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: PaymentMethod - -[internal](../modules/internal-14.md).PaymentMethod - -## Properties - -### data - -• `Optional` **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:143 - -___ - -### provider\_id - -• `Optional` **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:142 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal-14.ReturnItem.md deleted file mode 100644 index 917cf7a342..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnItem.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: ReturnItem - -[internal](../modules/internal-14.md).ReturnItem - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:155 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:158 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:156 - -___ - -### reason\_id - -• `Optional` **reason\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:157 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md b/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md deleted file mode 100644 index 3755799151..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-1.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ReturnShipping - -[internal](../modules/internal-14.md).ReturnShipping - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:161 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-swap.d.ts:162 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md b/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md deleted file mode 100644 index 5eb1ab7531..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping-2.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ReturnShipping - -[internal](../modules/internal-14.md).ReturnShipping - -## Properties - -### option\_id - -• `Optional` **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:188 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:189 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping.md b/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping.md deleted file mode 100644 index c61d8af6a5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ReturnShipping.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ReturnShipping - -[internal](../modules/internal-14.md).ReturnShipping - -## Properties - -### option\_id - -• `Optional` **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:133 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/request-return.d.ts:134 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md b/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md deleted file mode 100644 index f09662befc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-1.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: ShippingMethod - -[internal](../modules/internal-14.md).ShippingMethod - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:192 - -___ - -### option\_id - -• `Optional` **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:193 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/create-claim.d.ts:194 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md b/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md deleted file mode 100644 index 23359e1af3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod-2.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: ShippingMethod - -[internal](../modules/internal-14.md).ShippingMethod - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:151 - -___ - -### option\_id - -• `Optional` **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:152 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:153 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod.md b/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod.md deleted file mode 100644 index d35a958e06..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.ShippingMethod.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: ShippingMethod - -[internal](../modules/internal-14.md).ShippingMethod - -## Properties - -### data - -• `Optional` **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:149 - -___ - -### items - -• `Optional` **items**: `Record`<`string`, `unknown`\>[] - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:150 - -___ - -### price - -• `Optional` **price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:148 - -___ - -### profile\_id - -• `Optional` **profile\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:147 - -___ - -### provider\_id - -• `Optional` **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-order.d.ts:146 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.Tag.md b/www/apps/docs/content/references/js-client/classes/internal-14.Tag.md deleted file mode 100644 index 81c6a5e44c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-14.Tag.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Tag - -[internal](../modules/internal-14.md).Tag - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:168 - -___ - -### value - -• `Optional` **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/orders/update-claim.d.ts:169 diff --git a/www/apps/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionsReq.md deleted file mode 100644 index dffb47e2da..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-15.AdminUpdatePaymentCollectionsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminUpdatePaymentCollectionsReq - -[internal](../modules/internal-15.md).AdminUpdatePaymentCollectionsReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:74 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md deleted file mode 100644 index 49fd8f0ccf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-15.GetPaymentCollectionsParams.md +++ /dev/null @@ -1,37 +0,0 @@ -# Class: GetPaymentCollectionsParams - -[internal](../modules/internal-15.md).GetPaymentCollectionsParams - -## Hierarchy - -- [`FindParams`](internal-5.FindParams.md) - - ↳ **`GetPaymentCollectionsParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) - -#### Defined in - -medusa/dist/types/common.d.ts:117 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) - -#### Defined in - -medusa/dist/types/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md b/www/apps/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md deleted file mode 100644 index 5c05f008c4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-16.AdminPostPaymentRefundsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostPaymentRefundsReq - -[internal](../modules/internal-16.md).AdminPostPaymentRefundsReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/payments/refund-payment.d.ts:85 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/payments/refund-payment.d.ts:87 - -___ - -### reason - -• **reason**: [`RefundReason`](../enums/internal-16.RefundReason.md) - -#### Defined in - -medusa/dist/api/routes/admin/payments/refund-payment.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md deleted file mode 100644 index bce8dcf7c1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-16.GetPaymentsParams.md +++ /dev/null @@ -1,37 +0,0 @@ -# Class: GetPaymentsParams - -[internal](../modules/internal-16.md).GetPaymentsParams - -## Hierarchy - -- [`FindParams`](internal-5.FindParams.md) - - ↳ **`GetPaymentsParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) - -#### Defined in - -medusa/dist/types/common.d.ts:117 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) - -#### Defined in - -medusa/dist/types/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md b/www/apps/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md deleted file mode 100644 index 4d1227c4b7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminDeletePriceListPricesPricesReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeletePriceListPricesPricesReq - -[internal](../modules/internal-17.md).AdminDeletePriceListPricesPricesReq - -## Properties - -### price\_ids - -• **price\_ids**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md deleted file mode 100644 index 3dff579444..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListPaginationParams.md +++ /dev/null @@ -1,189 +0,0 @@ -# Class: AdminGetPriceListPaginationParams - -[internal](../modules/internal-17.md).AdminGetPriceListPaginationParams - -## Hierarchy - -- [`FilterablePriceListProps`](internal-17.FilterablePriceListProps.md) - - ↳ **`AdminGetPriceListPaginationParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[created_at](internal-17.FilterablePriceListProps.md#created_at) - -#### Defined in - -medusa/dist/types/price-list.d.ts:19 - -___ - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[customer_groups](internal-17.FilterablePriceListProps.md#customer_groups) - -#### Defined in - -medusa/dist/types/price-list.d.ts:16 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[deleted_at](internal-17.FilterablePriceListProps.md#deleted_at) - -#### Defined in - -medusa/dist/types/price-list.d.ts:21 - -___ - -### description - -• `Optional` **description**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[description](internal-17.FilterablePriceListProps.md#description) - -#### Defined in - -medusa/dist/types/price-list.d.ts:17 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:172 - -___ - -### id - -• `Optional` **id**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[id](internal-17.FilterablePriceListProps.md#id) - -#### Defined in - -medusa/dist/types/price-list.d.ts:12 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:171 - -___ - -### name - -• `Optional` **name**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[name](internal-17.FilterablePriceListProps.md#name) - -#### Defined in - -medusa/dist/types/price-list.d.ts:15 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:170 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:173 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[q](internal-17.FilterablePriceListProps.md#q) - -#### Defined in - -medusa/dist/types/price-list.d.ts:13 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[] - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[status](internal-17.FilterablePriceListProps.md#status) - -#### Defined in - -medusa/dist/types/price-list.d.ts:14 - -___ - -### type - -• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[] - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[type](internal-17.FilterablePriceListProps.md#type) - -#### Defined in - -medusa/dist/types/price-list.d.ts:18 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterablePriceListProps](internal-17.FilterablePriceListProps.md).[updated_at](internal-17.FilterablePriceListProps.md#updated_at) - -#### Defined in - -medusa/dist/types/price-list.d.ts:20 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md b/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md deleted file mode 100644 index e523fa51b7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListPricesPricesReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostPriceListPricesPricesReq - -[internal](../modules/internal-17.md).AdminPostPriceListPricesPricesReq - -## Properties - -### override - -• `Optional` **override**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:117 - -___ - -### prices - -• **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:116 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md b/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md deleted file mode 100644 index e6d2eabc4e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminPostPriceListsPriceListPriceListReq - -[internal](../modules/internal-17.md).AdminPostPriceListsPriceListPriceListReq - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:150 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:144 - -___ - -### ends\_at - -• `Optional` **ends\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:146 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:151 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:143 - -___ - -### prices - -• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-17.AdminPriceListPricesUpdateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:149 - -___ - -### starts\_at - -• `Optional` **starts\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:145 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:147 - -___ - -### type - -• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:148 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md b/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md deleted file mode 100644 index 5dfe07f3dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPostPriceListsPriceListReq.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminPostPriceListsPriceListReq - -[internal](../modules/internal-17.md).AdminPostPriceListsPriceListReq - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: [`CustomerGroup`](internal-17.CustomerGroup.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:170 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:164 - -___ - -### ends\_at - -• `Optional` **ends\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:166 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:171 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:163 - -___ - -### prices - -• **prices**: [`AdminPriceListPricesCreateReq`](internal-17.AdminPriceListPricesCreateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:169 - -___ - -### starts\_at - -• `Optional` **starts\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:165 - -___ - -### status - -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:167 - -___ - -### type - -• **type**: [`PriceListType`](../enums/internal.PriceListType.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:168 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md b/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md deleted file mode 100644 index 906c215424..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup-1.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: CustomerGroup - -[internal](../modules/internal-17.md).CustomerGroup - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:140 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup.md b/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup.md deleted file mode 100644 index 0a2a04fea0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-17.CustomerGroup.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: CustomerGroup - -[internal](../modules/internal-17.md).CustomerGroup - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:160 diff --git a/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md deleted file mode 100644 index b1546ec274..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsPaginationParams.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: AdminGetProductTagsPaginationParams - -[internal](../modules/internal-18.md).AdminGetProductTagsPaginationParams - -## Hierarchy - -- **`AdminGetProductTagsPaginationParams`** - - ↳ [`AdminGetProductTagsParams`](internal-18.AdminGetProductTagsParams.md) - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:133 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:134 diff --git a/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md b/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md deleted file mode 100644 index 5ebfcad538..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-18.AdminGetProductTagsParams.md +++ /dev/null @@ -1,107 +0,0 @@ -# Class: AdminGetProductTagsParams - -[internal](../modules/internal-18.md).AdminGetProductTagsParams - -## Hierarchy - -- [`AdminGetProductTagsPaginationParams`](internal-18.AdminGetProductTagsPaginationParams.md) - - ↳ **`AdminGetProductTagsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:140 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:143 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:137 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[AdminGetProductTagsPaginationParams](internal-18.AdminGetProductTagsPaginationParams.md).[limit](internal-18.AdminGetProductTagsPaginationParams.md#limit) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:133 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[AdminGetProductTagsPaginationParams](internal-18.AdminGetProductTagsPaginationParams.md).[offset](internal-18.AdminGetProductTagsPaginationParams.md#offset) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:134 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:142 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:138 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:141 - -___ - -### value - -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:139 diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md index 653fbfd181..2cb4c3865d 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchPaginationParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetBatchPaginationParams [internal](../modules/internal-2.md).AdminGetBatchPaginationParams @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:255 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:256 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:253 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:254 ___ @@ -56,4 +60,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:267 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:257 diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md index cd8b2479bc..abe35958ed 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-2.AdminGetBatchParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetBatchParams [internal](../modules/internal-2.md).AdminGetBatchParams @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:276 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:274 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:272 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:262 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:277 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:267 ___ @@ -60,7 +64,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:255 ___ @@ -70,7 +74,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:275 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:265 ___ @@ -84,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:266 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:256 ___ @@ -94,7 +98,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:270 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:260 ___ @@ -108,7 +112,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:253 ___ @@ -122,7 +126,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:264 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:254 ___ @@ -136,7 +140,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:267 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:257 ___ @@ -146,7 +150,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:273 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:263 ___ @@ -156,7 +160,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:271 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:261 ___ @@ -166,4 +170,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:278 +packages/medusa/dist/api/routes/admin/batch/list-batch-jobs.d.ts:268 diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md b/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md index dc25f2e2af..288bc6bc40 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-2.AdminPostBatchesReq.md @@ -1,16 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostBatchesReq [internal](../modules/internal-2.md).AdminPostBatchesReq +**`Schema`** + +AdminPostBatchesReq +type: object +required: + - type + - context +properties: + type: + type: string + description: The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy. + example: product-export + context: + type: object + description: Additional infomration regarding the batch to be used for processing. + example: + shape: + prices: + - region: null + currency_code: "eur" + dynamicImageColumnCount: 4 + dynamicOptionColumnCount: 2 + list_config: + skip: 0 + take: 50 + order: + created_at: "DESC" + relations: + - variants + - variant.prices + - images + dry_run: + type: boolean + description: Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed. + default: false + ## Properties ### context -• **context**: `Record`<`string`, `unknown`\> +• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:100 +packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:108 ___ @@ -20,7 +60,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:101 +packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:109 ___ @@ -30,4 +70,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:99 +packages/medusa/dist/api/routes/admin/batch/create-batch-job.d.ts:107 diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md b/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md index 20924da6f9..8a80cf7094 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md +++ b/www/apps/docs/content/references/js-client/classes/internal-2.BatchJob.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: BatchJob [internal](../modules/internal-2.md).BatchJob @@ -6,7 +10,7 @@ Base abstract entity for all entities ## Hierarchy -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) ↳ **`BatchJob`** @@ -18,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/batch-job.d.ts:27 +packages/medusa/dist/models/batch-job.d.ts:27 ___ @@ -28,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:23 +packages/medusa/dist/models/batch-job.d.ts:23 ___ @@ -38,7 +42,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:22 +packages/medusa/dist/models/batch-job.d.ts:22 ___ @@ -48,17 +52,17 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:21 +packages/medusa/dist/models/batch-job.d.ts:21 ___ ### context -• **context**: `Record`<`string`, `unknown`\> +• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/models/batch-job.d.ts:8 +packages/medusa/dist/models/batch-job.d.ts:8 ___ @@ -68,11 +72,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:6 +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -82,7 +86,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:6 +packages/medusa/dist/models/batch-job.d.ts:6 ___ @@ -92,7 +96,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:7 +packages/medusa/dist/models/batch-job.d.ts:7 ___ @@ -102,11 +106,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) #### Defined in -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 ___ @@ -116,7 +120,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:18 +packages/medusa/dist/models/batch-job.d.ts:18 ___ @@ -126,7 +130,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:24 +packages/medusa/dist/models/batch-job.d.ts:24 ___ @@ -136,11 +140,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:5 +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -150,7 +154,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:19 +packages/medusa/dist/models/batch-job.d.ts:19 ___ @@ -160,17 +164,17 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:20 +packages/medusa/dist/models/batch-job.d.ts:20 ___ ### result -• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: [`BatchJobResultError`](../modules/internal-2.md#batchjobresulterror)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../modules/internal-2.md#batchjobresultstatdescriptor)[] } & `Record`<`string`, `unknown`\> +• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \| [`BatchJobResultError`](../modules/internal-2.md#batchjobresulterror))[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: [`BatchJobResultStatDescriptor`](../modules/internal-2.md#batchjobresultstatdescriptor)[] } & [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/models/batch-job.d.ts:9 +packages/medusa/dist/models/batch-job.d.ts:9 ___ @@ -180,7 +184,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:25 +packages/medusa/dist/models/batch-job.d.ts:25 ___ @@ -190,7 +194,7 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:5 +packages/medusa/dist/models/batch-job.d.ts:5 ___ @@ -200,11 +204,11 @@ ___ #### Inherited from -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:7 +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 ## Methods @@ -218,7 +222,7 @@ medusa/dist/interfaces/models/base-entity.d.ts:7 #### Defined in -medusa/dist/models/batch-job.d.ts:26 +packages/medusa/dist/models/batch-job.d.ts:26 ___ @@ -232,4 +236,4 @@ ___ #### Defined in -medusa/dist/models/batch-job.d.ts:28 +packages/medusa/dist/models/batch-job.d.ts:28 diff --git a/www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md index 4f665a093e..5732b5db69 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md +++ b/www/apps/docs/content/references/js-client/classes/internal-2.DateComparisonOperator.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: DateComparisonOperator [internal](../modules/internal-2.md).DateComparisonOperator @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/common.d.ts:74 +packages/medusa/dist/types/common.d.ts:84 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:75 +packages/medusa/dist/types/common.d.ts:85 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:73 +packages/medusa/dist/types/common.d.ts:83 ___ @@ -40,4 +44,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:76 +packages/medusa/dist/types/common.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md deleted file mode 100644 index 850053c438..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminGetProductsParams.md +++ /dev/null @@ -1,275 +0,0 @@ -# Class: AdminGetProductsParams - -[internal](../modules/internal-20.md).AdminGetProductsParams - -API Level DTOs + Validation rules - -## Hierarchy - -- [`FilterableProductProps`](internal-20.FilterableProductProps.md) - - ↳ **`AdminGetProductsParams`** - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[collection_id](internal-20.FilterableProductProps.md#collection_id) - -#### Defined in - -medusa/dist/types/product.d.ts:13 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[created_at](internal-20.FilterableProductProps.md#created_at) - -#### Defined in - -medusa/dist/types/product.d.ts:22 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[deleted_at](internal-20.FilterableProductProps.md#deleted_at) - -#### Defined in - -medusa/dist/types/product.d.ts:24 - -___ - -### description - -• `Optional` **description**: `string` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[description](internal-20.FilterableProductProps.md#description) - -#### Defined in - -medusa/dist/types/product.d.ts:16 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[discount_condition_id](internal-20.FilterableProductProps.md#discount_condition_id) - -#### Defined in - -medusa/dist/types/product.d.ts:21 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/list-products.d.ts:213 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/list-products.d.ts:214 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[handle](internal-20.FilterableProductProps.md#handle) - -#### Defined in - -medusa/dist/types/product.d.ts:17 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[id](internal-20.FilterableProductProps.md#id) - -#### Defined in - -medusa/dist/types/product.d.ts:9 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[is_giftcard](internal-20.FilterableProductProps.md#is_giftcard) - -#### Defined in - -medusa/dist/types/product.d.ts:18 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/list-products.d.ts:212 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/list-products.d.ts:211 - -___ - -### price\_list\_id - -• `Optional` **price\_list\_id**: `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[price_list_id](internal-20.FilterableProductProps.md#price_list_id) - -#### Defined in - -medusa/dist/types/product.d.ts:12 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[q](internal-20.FilterableProductProps.md#q) - -#### Defined in - -medusa/dist/types/product.d.ts:10 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[sales_channel_id](internal-20.FilterableProductProps.md#sales_channel_id) - -#### Defined in - -medusa/dist/types/product.d.ts:20 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[status](internal-20.FilterableProductProps.md#status) - -#### Defined in - -medusa/dist/types/product.d.ts:11 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[tags](internal-20.FilterableProductProps.md#tags) - -#### Defined in - -medusa/dist/types/product.d.ts:14 - -___ - -### title - -• `Optional` **title**: `string` - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[title](internal-20.FilterableProductProps.md#title) - -#### Defined in - -medusa/dist/types/product.d.ts:15 - -___ - -### type\_id - -• `Optional` **type\_id**: `string`[] - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[type_id](internal-20.FilterableProductProps.md#type_id) - -#### Defined in - -medusa/dist/types/product.d.ts:19 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterableProductProps](internal-20.FilterableProductProps.md).[updated_at](internal-20.FilterableProductProps.md#updated_at) - -#### Defined in - -medusa/dist/types/product.d.ts:23 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md deleted file mode 100644 index d86ee737fb..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductMetadataReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostProductsProductMetadataReq - -[internal](../modules/internal-20.md).AdminPostProductsProductMetadataReq - -## Properties - -### key - -• **key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/set-metadata.d.ts:79 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/set-metadata.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md deleted file mode 100644 index 7d305c8dce..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsOption.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostProductsProductOptionsOption - -[internal](../modules/internal-20.md).AdminPostProductsProductOptionsOption - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-option.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md deleted file mode 100644 index b800fb7f8e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductOptionsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostProductsProductOptionsReq - -[internal](../modules/internal-20.md).AdminPostProductsProductOptionsReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/add-option.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md deleted file mode 100644 index 40c1a9c9bd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductReq.md +++ /dev/null @@ -1,223 +0,0 @@ -# Class: AdminPostProductsProductReq - -[internal](../modules/internal-20.md).AdminPostProductsProductReq - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:295 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:288 - -___ - -### discountable - -• `Optional` **discountable**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:289 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:292 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:301 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:303 - -___ - -### images - -• `Optional` **images**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:290 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:300 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:306 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:307 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:305 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:304 - -___ - -### sales\_channels - -• `Optional` **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:297 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:293 - -___ - -### subtitle - -• `Optional` **subtitle**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:287 - -___ - -### tags - -• `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:296 - -___ - -### thumbnail - -• `Optional` **thumbnail**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:291 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:286 - -___ - -### type - -• `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md) - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:294 - -___ - -### variants - -• `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:298 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:299 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:302 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md deleted file mode 100644 index 02d4cc5096..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsReq.md +++ /dev/null @@ -1,193 +0,0 @@ -# Class: AdminPostProductsProductVariantsReq - -[internal](../modules/internal-20.md).AdminPostProductsProductVariantsReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:201 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:198 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:196 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:205 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:199 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:200 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:204 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:202 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:209 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:210 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:208 - -___ - -### options - -• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:212 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:207 - -___ - -### prices - -• **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:211 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:195 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:194 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:197 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:203 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:206 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md deleted file mode 100644 index 739a4d41b0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsProductVariantsVariantReq.md +++ /dev/null @@ -1,193 +0,0 @@ -# Class: AdminPostProductsProductVariantsVariantReq - -[internal](../modules/internal-20.md).AdminPostProductsProductVariantsVariantReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:193 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:190 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:188 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:197 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:191 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:192 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:196 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:194 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:201 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:202 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:200 - -___ - -### options - -• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:204 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:199 - -___ - -### prices - -• `Optional` **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:203 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:187 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:186 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:189 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:195 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:198 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md deleted file mode 100644 index 142056af54..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.AdminPostProductsReq.md +++ /dev/null @@ -1,243 +0,0 @@ -# Class: AdminPostProductsReq - -[internal](../modules/internal-20.md).AdminPostProductsReq - -## Properties - -### collection\_id - -• `Optional` **collection\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:310 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:302 - -___ - -### discountable - -• **discountable**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:304 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:307 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:317 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:319 - -___ - -### images - -• `Optional` **images**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:305 - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:303 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:316 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:322 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:323 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:321 - -___ - -### options - -• `Optional` **options**: [`ProductOptionReq`](internal-20.ProductOptionReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:313 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:320 - -___ - -### sales\_channels - -• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-20.ProductSalesChannelReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:312 - -___ - -### status - -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:308 - -___ - -### subtitle - -• `Optional` **subtitle**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:301 - -___ - -### tags - -• `Optional` **tags**: [`ProductTagReq`](internal-20.ProductTagReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:311 - -___ - -### thumbnail - -• `Optional` **thumbnail**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:306 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:300 - -___ - -### type - -• `Optional` **type**: [`ProductTypeReq`](internal-20.ProductTypeReq.md) - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:309 - -___ - -### variants - -• `Optional` **variants**: [`ProductVariantReq`](internal-20.ProductVariantReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:314 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:315 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:318 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md deleted file mode 100644 index a1841a327f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductOptionReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductOptionReq - -[internal](../modules/internal-20.md).ProductOptionReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:276 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md deleted file mode 100644 index fbc5c4910b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductSalesChannelReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductSalesChannelReq - -[internal](../modules/internal-20.md).ProductSalesChannelReq - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/types/product.d.ts:140 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductTagReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductTagReq.md deleted file mode 100644 index f1515df2db..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductTagReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductTagReq - -[internal](../modules/internal-20.md).ProductTagReq - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/types/product.d.ts:143 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/types/product.d.ts:144 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md deleted file mode 100644 index 2db35b8fa6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductTypeReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductTypeReq - -[internal](../modules/internal-20.md).ProductTypeReq - -## Properties - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/types/product.d.ts:147 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/types/product.d.ts:148 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md deleted file mode 100644 index 1d6f9f1a66..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-1.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-20.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:183 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-variant.d.ts:182 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md deleted file mode 100644 index 1938cab9e1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-2.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-20.md).ProductVariantOptionReq - -## Properties - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:273 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md deleted file mode 100644 index 403bea4bea..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq-3.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-20.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:261 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:260 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md deleted file mode 100644 index 6926d54067..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantOptionReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: ProductVariantOptionReq - -[internal](../modules/internal-20.md).ProductVariantOptionReq - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:191 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-variant.d.ts:190 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md deleted file mode 100644 index 8d45daab87..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq-1.md +++ /dev/null @@ -1,203 +0,0 @@ -# Class: ProductVariantReq - -[internal](../modules/internal-20.md).ProductVariantReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:272 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:269 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:267 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:276 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:270 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:264 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:271 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:275 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:273 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:280 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:281 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:279 - -___ - -### options - -• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-3.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:283 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:278 - -___ - -### prices - -• `Optional` **prices**: [`ProductVariantPricesUpdateReq`](internal-20.ProductVariantPricesUpdateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:282 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:266 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:265 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:268 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:274 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/update-product.d.ts:277 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md b/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md deleted file mode 100644 index 5d58dde0ac..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantReq.md +++ /dev/null @@ -1,193 +0,0 @@ -# Class: ProductVariantReq - -[internal](../modules/internal-20.md).ProductVariantReq - -## Properties - -### allow\_backorder - -• `Optional` **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:286 - -___ - -### barcode - -• `Optional` **barcode**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:283 - -___ - -### ean - -• `Optional` **ean**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:281 - -___ - -### height - -• `Optional` **height**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:290 - -___ - -### hs\_code - -• `Optional` **hs\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:284 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:285 - -___ - -### length - -• `Optional` **length**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:289 - -___ - -### manage\_inventory - -• `Optional` **manage\_inventory**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:287 - -___ - -### material - -• `Optional` **material**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:294 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:295 - -___ - -### mid\_code - -• `Optional` **mid\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:293 - -___ - -### options - -• `Optional` **options**: [`ProductVariantOptionReq`](internal-20.ProductVariantOptionReq-2.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:297 - -___ - -### origin\_country - -• `Optional` **origin\_country**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:292 - -___ - -### prices - -• **prices**: [`ProductVariantPricesCreateReq`](internal-20.ProductVariantPricesCreateReq.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:296 - -___ - -### sku - -• `Optional` **sku**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:280 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:279 - -___ - -### upc - -• `Optional` **upc**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:282 - -___ - -### weight - -• `Optional` **weight**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:288 - -___ - -### width - -• `Optional` **width**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/products/create-product.d.ts:291 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md deleted file mode 100644 index c3f047361a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeletePublishableApiKeySalesChannelsBatchReq - -[internal](../modules/internal-21.md).AdminDeletePublishableApiKeySalesChannelsBatchReq - -## Properties - -### sales\_channel\_ids - -• **sales\_channel\_ids**: [`ProductBatchSalesChannel`](internal-21.ProductBatchSalesChannel.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/delete-channels-batch.d.ts:89 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md deleted file mode 100644 index 7e3ca74b1c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostPublishableApiKeySalesChannelsBatchReq - -[internal](../modules/internal-21.md).AdminPostPublishableApiKeySalesChannelsBatchReq - -## Properties - -### sales\_channel\_ids - -• **sales\_channel\_ids**: [`ProductBatchSalesChannel`](internal-21.ProductBatchSalesChannel.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/add-channels-batch.d.ts:89 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md b/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md deleted file mode 100644 index 129d895d05..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostPublishableApiKeysPublishableApiKeyReq - -[internal](../modules/internal-21.md).AdminPostPublishableApiKeysPublishableApiKeyReq - -## Properties - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md b/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md deleted file mode 100644 index 3a0217b4ba..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.AdminPostPublishableApiKeysReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostPublishableApiKeysReq - -[internal](../modules/internal-21.md).AdminPostPublishableApiKeysReq - -## Properties - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/create-publishable-api-key.d.ts:67 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeySalesChannelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeySalesChannelsParams.md deleted file mode 100644 index 200d6f73ae..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeySalesChannelsParams.md +++ /dev/null @@ -1,3 +0,0 @@ -# Class: GetPublishableApiKeySalesChannelsParams - -[internal](../modules/internal-21.md).GetPublishableApiKeySalesChannelsParams diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.ProductBatchSalesChannel.md b/www/apps/docs/content/references/js-client/classes/internal-21.ProductBatchSalesChannel.md deleted file mode 100644 index f57c20de78..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.ProductBatchSalesChannel.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ProductBatchSalesChannel - -[internal](../modules/internal-21.md).ProductBatchSalesChannel - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/types/sales-channels.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md b/www/apps/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md deleted file mode 100644 index 9b360d2a59..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-21.PublishableApiKey.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: PublishableApiKey - -[internal](../modules/internal-21.md).PublishableApiKey - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`PublishableApiKey`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/publishable-api-key.d.ts:7 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### created\_by - -• **created\_by**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/publishable-api-key.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### revoked\_at - -• `Optional` **revoked\_at**: `Date` - -#### Defined in - -medusa/dist/models/publishable-api-key.d.ts:5 - -___ - -### revoked\_by - -• **revoked\_by**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/publishable-api-key.d.ts:4 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/publishable-api-key.d.ts:6 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md deleted file mode 100644 index 139c1d13e6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsPaginationParams.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: AdminGetRegionsPaginationParams - -[internal](../modules/internal-22.md).AdminGetRegionsPaginationParams - -## Hierarchy - -- **`AdminGetRegionsPaginationParams`** - - ↳ [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:99 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:100 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md deleted file mode 100644 index eeaf34a51a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsParams.md +++ /dev/null @@ -1,67 +0,0 @@ -# Class: AdminGetRegionsParams - -[internal](../modules/internal-22.md).AdminGetRegionsParams - -## Hierarchy - -- [`AdminGetRegionsPaginationParams`](internal-22.AdminGetRegionsPaginationParams.md) - - ↳ **`AdminGetRegionsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:103 - -___ - -### deleted\_at - -• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:105 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[AdminGetRegionsPaginationParams](internal-22.AdminGetRegionsPaginationParams.md).[limit](internal-22.AdminGetRegionsPaginationParams.md#limit) - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:99 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[AdminGetRegionsPaginationParams](internal-22.AdminGetRegionsPaginationParams.md).[offset](internal-22.AdminGetRegionsPaginationParams.md#offset) - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:100 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/regions/list-regions.d.ts:104 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md deleted file mode 100644 index cddff07b98..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminGetRegionsRegionFulfillmentOptionsRes - -[internal](../modules/internal-22.md).AdminGetRegionsRegionFulfillmentOptionsRes - -## Properties - -### fulfillment\_options - -• **fulfillment\_options**: [`FulfillmentOption`](internal-22.FulfillmentOption.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:21 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md deleted file mode 100644 index 07837873d1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionCountriesReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostRegionsRegionCountriesReq - -[internal](../modules/internal-22.md).AdminPostRegionsRegionCountriesReq - -## Properties - -### country\_code - -• **country\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/add-country.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md deleted file mode 100644 index 7ee04dadb1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostRegionsRegionFulfillmentProvidersReq - -[internal](../modules/internal-22.md).AdminPostRegionsRegionFulfillmentProvidersReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md deleted file mode 100644 index 43646f348b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostRegionsRegionPaymentProvidersReq - -[internal](../modules/internal-22.md).AdminPostRegionsRegionPaymentProvidersReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md deleted file mode 100644 index 64e7cc724a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsRegionReq.md +++ /dev/null @@ -1,123 +0,0 @@ -# Class: AdminPostRegionsRegionReq - -[internal](../modules/internal-22.md).AdminPostRegionsRegionReq - -## Properties - -### automatic\_taxes - -• `Optional` **automatic\_taxes**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:115 - -___ - -### countries - -• `Optional` **countries**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:119 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:111 - -___ - -### fulfillment\_providers - -• `Optional` **fulfillment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:118 - -___ - -### gift\_cards\_taxable - -• `Optional` **gift\_cards\_taxable**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:114 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:120 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:121 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:110 - -___ - -### payment\_providers - -• `Optional` **payment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:117 - -___ - -### tax\_code - -• `Optional` **tax\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:112 - -___ - -### tax\_provider\_id - -• `Optional` **tax\_provider\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:116 - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/regions/update-region.d.ts:113 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md deleted file mode 100644 index 18606cde29..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminPostRegionsReq.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminPostRegionsReq - -[internal](../modules/internal-22.md).AdminPostRegionsReq - -## Properties - -### countries - -• **countries**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:135 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:130 - -___ - -### fulfillment\_providers - -• **fulfillment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:134 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:136 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:137 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:129 - -___ - -### payment\_providers - -• **payment\_providers**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:133 - -___ - -### tax\_code - -• `Optional` **tax\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:131 - -___ - -### tax\_rate - -• **tax\_rate**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/regions/create-region.d.ts:132 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md b/www/apps/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md deleted file mode 100644 index fac35d4120..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.AdminRegionsRes.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminRegionsRes - -[internal](../modules/internal-22.md).AdminRegionsRes - -## Properties - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md b/www/apps/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md deleted file mode 100644 index 7245dd9743..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-22.FulfillmentOption.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: FulfillmentOption - -[internal](../modules/internal-22.md).FulfillmentOption - -## Properties - -### options - -• **options**: `unknown`[] - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:18 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md b/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md deleted file mode 100644 index 2982dbb6a4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReasonReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: AdminPostReturnReasonsReasonReq - -[internal](../modules/internal-23.md).AdminPostReturnReasonsReasonReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:82 - -___ - -### label - -• `Optional` **label**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:80 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:83 - -___ - -### value - -• `Optional` **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:81 diff --git a/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md b/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md deleted file mode 100644 index e0cfd3d69e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-23.AdminPostReturnReasonsReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminPostReturnReasonsReq - -[internal](../modules/internal-23.md).AdminPostReturnReasonsReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:89 - -___ - -### label - -• **label**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:87 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:90 - -___ - -### parent\_return\_reason\_id - -• `Optional` **parent\_return\_reason\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:88 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md b/www/apps/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md deleted file mode 100644 index 87a6f08ad9..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-24.AdminGetReturnsParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminGetReturnsParams - -[internal](../modules/internal-24.md).AdminGetReturnsParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/list-returns.d.ts:67 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/list-returns.d.ts:68 diff --git a/www/apps/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md b/www/apps/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md deleted file mode 100644 index a71a3d036f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-24.AdminPostReturnsReturnReceiveReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostReturnsReturnReceiveReq - -[internal](../modules/internal-24.md).AdminPostReturnsReturnReceiveReq - -## Properties - -### items - -• **items**: [`Item`](internal-24.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:100 - -___ - -### refund - -• `Optional` **refund**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-24.Item.md b/www/apps/docs/content/references/js-client/classes/internal-24.Item.md deleted file mode 100644 index 7f23b3b631..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-24.Item.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Item - -[internal](../modules/internal-24.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:96 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/returns/receive-return.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md deleted file mode 100644 index 5e83e85e3d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteSalesChannelsChannelProductsBatchReq - -[internal](../modules/internal-25.md).AdminDeleteSalesChannelsChannelProductsBatchReq - -## Properties - -### product\_ids - -• **product\_ids**: [`ProductBatchSalesChannel`](internal-21.ProductBatchSalesChannel.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts:91 diff --git a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md deleted file mode 100644 index 199f477c39..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostSalesChannelsChannelProductsBatchReq - -[internal](../modules/internal-25.md).AdminPostSalesChannelsChannelProductsBatchReq - -## Properties - -### product\_ids - -• **product\_ids**: [`ProductBatchSalesChannel`](internal-21.ProductBatchSalesChannel.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts:91 diff --git a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md b/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md deleted file mode 100644 index ebb10084bd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostSalesChannelsReq - -[internal](../modules/internal-25.md).AdminPostSalesChannelsReq - -## Properties - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:80 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:81 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md b/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md deleted file mode 100644 index 58ea870c20..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostSalesChannelsSalesChannelReq - -[internal](../modules/internal-25.md).AdminPostSalesChannelsSalesChannelReq - -## Properties - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:79 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:80 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md deleted file mode 100644 index 457ae342d7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-26.AdminGetShippingOptionsParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminGetShippingOptionsParams - -[internal](../modules/internal-26.md).AdminGetShippingOptionsParams - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:77 - -___ - -### is\_return - -• `Optional` **is\_return**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:76 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md deleted file mode 100644 index 4852ae867b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsOptionReq.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: AdminPostShippingOptionsOptionReq - -[internal](../modules/internal-26.md).AdminPostShippingOptionsOptionReq - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:125 - -___ - -### amount - -• `Optional` **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:123 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:127 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:126 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:122 - -___ - -### requirements - -• **requirements**: [`OptionRequirement`](internal-26.OptionRequirement-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:124 diff --git a/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md deleted file mode 100644 index 4329f33575..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-26.AdminPostShippingOptionsReq.md +++ /dev/null @@ -1,123 +0,0 @@ -# Class: AdminPostShippingOptionsReq - -[internal](../modules/internal-26.md).AdminPostShippingOptionsReq - -## Properties - -### admin\_only - -• `Optional` **admin\_only**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:148 - -___ - -### amount - -• `Optional` **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:146 - -___ - -### data - -• **data**: `object` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:144 - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:151 - -___ - -### is\_return - -• `Optional` **is\_return**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:149 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:150 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:140 - -___ - -### price\_type - -• **price\_type**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:145 - -___ - -### profile\_id - -• `Optional` **profile\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:143 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:142 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:141 - -___ - -### requirements - -• `Optional` **requirements**: [`OptionRequirement`](internal-26.OptionRequirement.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:147 diff --git a/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md b/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md deleted file mode 100644 index 7224de5acf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement-1.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: OptionRequirement - -[internal](../modules/internal-26.md).OptionRequirement - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:119 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:117 - -___ - -### type - -• **type**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement.md b/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement.md deleted file mode 100644 index 043b359c03..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-26.OptionRequirement.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: OptionRequirement - -[internal](../modules/internal-26.md).OptionRequirement - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:137 - -___ - -### type - -• **type**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:136 diff --git a/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md b/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md deleted file mode 100644 index 2d91f7b5dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesProfileReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostShippingProfilesProfileReq - -[internal](../modules/internal-27.md).AdminPostShippingProfilesProfileReq - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md b/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md deleted file mode 100644 index a344c77bdd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-27.AdminPostShippingProfilesReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostShippingProfilesReq - -[internal](../modules/internal-27.md).AdminPostShippingProfilesReq - -## Properties - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md b/www/apps/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md deleted file mode 100644 index 6f5799ff16..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-28.AdminPostStoreReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: AdminPostStoreReq - -[internal](../modules/internal-28.md).AdminPostStoreReq - -## Properties - -### currencies - -• `Optional` **currencies**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:97 - -___ - -### default\_currency\_code - -• `Optional` **default\_currency\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:96 - -___ - -### invite\_link\_template - -• `Optional` **invite\_link\_template**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:95 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:98 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:92 - -___ - -### payment\_link\_template - -• `Optional` **payment\_link\_template**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:94 - -___ - -### swap\_link\_template - -• `Optional` **swap\_link\_template**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/store/update-store.d.ts:93 diff --git a/www/apps/docs/content/references/js-client/classes/internal-28.Store.md b/www/apps/docs/content/references/js-client/classes/internal-28.Store.md deleted file mode 100644 index 31d009b31d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-28.Store.md +++ /dev/null @@ -1,163 +0,0 @@ -# Class: Store - -[internal](../modules/internal-28.md).Store - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Store`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/store.d.ts:15 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### currencies - -• **currencies**: [`Currency`](internal.Currency.md)[] - -#### Defined in - -medusa/dist/models/store.d.ts:8 - -___ - -### default\_currency - -• **default\_currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/store.d.ts:7 - -___ - -### default\_currency\_code - -• **default\_currency\_code**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:6 - -___ - -### default\_sales\_channel - -• **default\_sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) - -#### Defined in - -medusa/dist/models/store.d.ts:14 - -___ - -### default\_sales\_channel\_id - -• **default\_sales\_channel\_id**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:13 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### invite\_link\_template - -• **invite\_link\_template**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:11 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/store.d.ts:12 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:5 - -___ - -### payment\_link\_template - -• **payment\_link\_template**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:10 - -___ - -### swap\_link\_template - -• **swap\_link\_template**: `string` - -#### Defined in - -medusa/dist/models/store.d.ts:9 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md b/www/apps/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md deleted file mode 100644 index 871928d64e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-29.AdminGetSwapsParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminGetSwapsParams - -[internal](../modules/internal-29.md).AdminGetSwapsParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:68 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Address.md b/www/apps/docs/content/references/js-client/classes/internal-3.Address.md new file mode 100644 index 0000000000..0ead406ef4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Address.md @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Address + +[internal](../modules/internal-3.md).Address + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Address`** + +## Properties + +### address\_1 + +• **address\_1**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:10 + +___ + +### address\_2 + +• **address\_2**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:11 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:19 + +___ + +### city + +• **city**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:12 + +___ + +### company + +• **company**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:7 + +___ + +### country + +• **country**: ``null`` \| [`Country`](internal-3.Country.md) + +#### Defined in + +packages/medusa/dist/models/address.d.ts:14 + +___ + +### country\_code + +• **country\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:13 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: ``null`` \| [`Customer`](internal-3.Customer.md) + +#### Defined in + +packages/medusa/dist/models/address.d.ts:6 + +___ + +### customer\_id + +• **customer\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:5 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### first\_name + +• **first\_name**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:8 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### last\_name + +• **last\_name**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:9 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/address.d.ts:18 + +___ + +### phone + +• **phone**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:17 + +___ + +### postal\_code + +• **postal\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:16 + +___ + +### province + +• **province**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/address.d.ts:15 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md index 170b01c70b..019c8c8030 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminDeleteProductsFromCollectionReq.md @@ -1,7 +1,25 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminDeleteProductsFromCollectionReq [internal](../modules/internal-3.md).AdminDeleteProductsFromCollectionReq +**`Schema`** + +AdminDeleteProductsFromCollectionReq +type: object +required: + - product_ids +properties: + product_ids: + description: "An array of Product IDs to remove from the Product Collection." + type: array + items: + description: "The ID of a Product to add to the Product Collection." + type: string + ## Properties ### product\_ids @@ -10,4 +28,4 @@ #### Defined in -medusa/dist/api/routes/admin/collections/remove-products.d.ts:78 +packages/medusa/dist/api/routes/admin/collections/remove-products.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md index f0946d6623..ba079c4347 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsPaginationParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetCollectionsPaginationParams [internal](../modules/internal-3.md).AdminGetCollectionsPaginationParams @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:140 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:130 ___ @@ -26,4 +30,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:141 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:131 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md index 4b2e090eed..d3433d0695 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminGetCollectionsParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetCollectionsParams [internal](../modules/internal-3.md).AdminGetCollectionsParams @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:146 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:136 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:148 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:138 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:150 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:140 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:145 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:135 ___ @@ -60,7 +64,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:140 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:130 ___ @@ -74,7 +78,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:141 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:131 ___ @@ -84,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:149 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:139 ___ @@ -94,7 +98,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:144 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:134 ___ @@ -104,4 +108,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/list-collections.d.ts:147 +packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:137 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md index a1edb17930..3b775fedf5 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsCollectionReq.md @@ -1,7 +1,29 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostCollectionsCollectionReq [internal](../modules/internal-3.md).AdminPostCollectionsCollectionReq +**`Schema`** + +AdminPostCollectionsCollectionReq +type: object +properties: + title: + type: string + description: The title of the collection. + handle: + type: string + description: An optional handle to be used in slugs. If none is provided, the kebab-case version of the title will be used. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + ## Properties ### handle @@ -10,17 +32,17 @@ #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:79 +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:86 ___ ### metadata -• `Optional` **metadata**: `Record`<`string`, `unknown`\> +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:80 +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:87 ___ @@ -30,4 +52,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/update-collection.d.ts:78 +packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md index 5caa7ebb4f..8caa9ca4e9 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostCollectionsReq.md @@ -1,7 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostCollectionsReq [internal](../modules/internal-3.md).AdminPostCollectionsReq +**`Schema`** + +AdminPostCollectionsReq +type: object +required: + - title +properties: + title: + type: string + description: The title of the collection. + handle: + type: string + description: An optional handle to be used in slugs. If none is provided, the kebab-case version of the title will be used. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + ## Properties ### handle @@ -10,17 +34,17 @@ #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:79 +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:86 ___ ### metadata -• `Optional` **metadata**: `Record`<`string`, `unknown`\> +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:80 +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:87 ___ @@ -30,4 +54,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/collections/create-collection.d.ts:78 +packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md index e123ff3642..b1702423a8 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.AdminPostProductsToCollectionReq.md @@ -1,7 +1,25 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostProductsToCollectionReq [internal](../modules/internal-3.md).AdminPostProductsToCollectionReq +**`Schema`** + +AdminPostProductsToCollectionReq +type: object +required: + - product_ids +properties: + product_ids: + description: "An array of Product IDs to add to the Product Collection." + type: array + items: + description: "The ID of a Product to add to the Product Collection." + type: string + ## Properties ### product\_ids @@ -10,4 +28,4 @@ #### Defined in -medusa/dist/api/routes/admin/collections/add-products.d.ts:67 +packages/medusa/dist/api/routes/admin/collections/add-products.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Cart.md b/www/apps/docs/content/references/js-client/classes/internal-3.Cart.md new file mode 100644 index 0000000000..808cde92ca --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Cart.md @@ -0,0 +1,471 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Cart + +[internal](../modules/internal-3.md).Cart + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Cart`** + +## Properties + +### afterLoad + +• `Private` **afterLoad**: `any` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:289 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:290 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:254 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:253 + +___ + +### completed\_at + +• **completed\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:270 + +___ + +### context + +• **context**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:273 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: [`Customer`](internal-3.Customer.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:263 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:262 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### discount\_total + +• `Optional` **discount\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:278 + +___ + +### discounts + +• **discounts**: [`Discount`](internal-3.Discount.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:260 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:252 + +___ + +### gift\_card\_tax\_total + +• `Optional` **gift\_card\_tax\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:288 + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:287 + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](internal-3.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:261 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:272 + +___ + +### item\_tax\_total + +• `Optional` **item\_tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:280 + +___ + +### items + +• **items**: [`LineItem`](internal-3.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:257 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:274 + +___ + +### object + +• `Readonly` **object**: ``"cart"`` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:251 + +___ + +### payment + +• **payment**: [`Payment`](internal-3.Payment.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:267 + +___ + +### payment\_authorized\_at + +• **payment\_authorized\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:271 + +___ + +### payment\_id + +• **payment\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:266 + +___ + +### payment\_session + +• **payment\_session**: ``null`` \| [`PaymentSession`](internal-3.PaymentSession.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:264 + +___ + +### payment\_sessions + +• **payment\_sessions**: [`PaymentSession`](internal-3.PaymentSession.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:265 + +___ + +### raw\_discount\_total + +• `Optional` **raw\_discount\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:279 + +___ + +### refundable\_amount + +• `Optional` **refundable\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:286 + +___ + +### refunded\_total + +• `Optional` **refunded\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:283 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:259 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:258 + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](internal-3.SalesChannel.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:276 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:275 + +___ + +### shipping\_address + +• **shipping\_address**: ``null`` \| [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:256 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:255 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal-3.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:268 + +___ + +### shipping\_tax\_total + +• `Optional` **shipping\_tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:281 + +___ + +### shipping\_total + +• `Optional` **shipping\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:277 + +___ + +### subtotal + +• `Optional` **subtotal**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:285 + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:282 + +___ + +### total + +• `Optional` **total**: `number` + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:284 + +___ + +### type + +• **type**: [`CartType`](../enums/internal-3.CartType.md) + +#### Defined in + +packages/medusa/dist/models/cart.d.ts:269 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md new file mode 100644 index 0000000000..48f8f0b929 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimImage.md @@ -0,0 +1,121 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimImage + +[internal](../modules/internal-3.md).ClaimImage + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ClaimImage`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/claim-image.d.ts:8 + +___ + +### claim\_item + +• **claim\_item**: [`ClaimItem`](internal-3.ClaimItem.md) + +#### Defined in + +packages/medusa/dist/models/claim-image.d.ts:5 + +___ + +### claim\_item\_id + +• **claim\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-image.d.ts:4 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/claim-image.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### url + +• **url**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-image.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md new file mode 100644 index 0000000000..b5e750f264 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimItem.md @@ -0,0 +1,201 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimItem + +[internal](../modules/internal-3.md).ClaimItem + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ClaimItem`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:26 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal-3.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:16 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:15 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### images + +• **images**: [`ClaimImage`](internal-3.ClaimImage.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:14 + +___ + +### item + +• **item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:18 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:17 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:25 + +___ + +### note + +• **note**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:22 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:23 + +___ + +### reason + +• **reason**: [`ClaimReason`](../enums/internal-3.ClaimReason.md) + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:21 + +___ + +### tags + +• **tags**: [`ClaimTag`](internal-3.ClaimTag.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:24 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal-3.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:20 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-item.d.ts:19 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md new file mode 100644 index 0000000000..3790d40333 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimOrder.md @@ -0,0 +1,251 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimOrder + +[internal](../modules/internal-3.md).ClaimOrder + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ClaimOrder`** + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](internal-3.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:33 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:50 + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:43 + +___ + +### claim\_items + +• **claim\_items**: [`ClaimItem`](internal-3.ClaimItem.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:32 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Overrides + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:44 + +___ + +### deleted\_at + +• **deleted\_at**: `Date` + +#### Overrides + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:46 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/internal-3.ClaimFulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:31 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal-3.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:41 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:49 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:48 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:47 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:36 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:35 + +___ + +### payment\_status + +• **payment\_status**: [`ClaimPaymentStatus`](../enums/internal-3.ClaimPaymentStatus.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:30 + +___ + +### refund\_amount + +• **refund\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:42 + +___ + +### return\_order + +• **return\_order**: [`Return`](internal-3.Return.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:37 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:39 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:38 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal-3.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:40 + +___ + +### type + +• **type**: [`ClaimType`](../enums/internal-3.ClaimType.md) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:34 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Overrides + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/models/claim-order.d.ts:45 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md new file mode 100644 index 0000000000..767245a2b5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ClaimTag.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimTag + +[internal](../modules/internal-3.md).ClaimTag + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ClaimTag`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/claim-tag.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/claim-tag.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/claim-tag.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Country.md b/www/apps/docs/content/references/js-client/classes/internal-3.Country.md similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal.Country.md rename to www/apps/docs/content/references/js-client/classes/internal-3.Country.md index acbf228b6e..a76c651dd1 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.Country.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Country.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Class: Country -[internal](../modules/internal.md).Country +[internal](../modules/internal-3.md).Country ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/country.d.ts:8 +packages/medusa/dist/models/country.d.ts:8 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:3 +packages/medusa/dist/models/country.d.ts:3 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:4 +packages/medusa/dist/models/country.d.ts:4 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:5 +packages/medusa/dist/models/country.d.ts:5 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:7 +packages/medusa/dist/models/country.d.ts:7 ___ @@ -64,17 +64,17 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:6 +packages/medusa/dist/models/country.d.ts:6 ___ ### region -• **region**: [`Region`](internal.Region.md) +• **region**: [`Region`](internal-3.Region.md) #### Defined in -medusa/dist/models/country.d.ts:10 +packages/medusa/dist/models/country.d.ts:10 ___ @@ -84,4 +84,4 @@ ___ #### Defined in -medusa/dist/models/country.d.ts:9 +packages/medusa/dist/models/country.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Currency.md b/www/apps/docs/content/references/js-client/classes/internal-3.Currency.md similarity index 60% rename from www/apps/docs/content/references/js-client/classes/internal.Currency.md rename to www/apps/docs/content/references/js-client/classes/internal-3.Currency.md index 5ed52ff837..fe90cc4181 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.Currency.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Currency.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Class: Currency -[internal](../modules/internal.md).Currency +[internal](../modules/internal-3.md).Currency ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/currency.d.ts:2 +packages/medusa/dist/models/currency.d.ts:2 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/currency.d.ts:6 +packages/medusa/dist/models/currency.d.ts:6 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/currency.d.ts:5 +packages/medusa/dist/models/currency.d.ts:5 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/currency.d.ts:3 +packages/medusa/dist/models/currency.d.ts:3 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/currency.d.ts:4 +packages/medusa/dist/models/currency.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Customer.md b/www/apps/docs/content/references/js-client/classes/internal-3.Customer.md new file mode 100644 index 0000000000..5ffef72c6b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Customer.md @@ -0,0 +1,201 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Customer + +[internal](../modules/internal-3.md).Customer + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Customer`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:18 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:10 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:9 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:6 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:7 + +___ + +### groups + +• **groups**: [`CustomerGroup`](internal-3.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:16 + +___ + +### has\_account + +• **has\_account**: `boolean` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:14 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:8 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:17 + +___ + +### orders + +• **orders**: [`Order`](internal-3.Order.md)[] + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:15 + +___ + +### password\_hash + +• **password\_hash**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:12 + +___ + +### phone + +• **phone**: `string` + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:13 + +___ + +### shipping\_addresses + +• **shipping\_addresses**: [`Address`](internal-3.Address.md)[] + +#### Defined in + +packages/medusa/dist/models/customer.d.ts:11 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md b/www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md new file mode 100644 index 0000000000..77bdf2afb6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.CustomerGroup.md @@ -0,0 +1,121 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroup + +[internal](../modules/internal-3.md).CustomerGroup + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`CustomerGroup`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:9 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customers + +• **customers**: [`Customer`](internal-3.Customer.md)[] + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:8 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:5 + +___ + +### price\_lists + +• **price\_lists**: [`PriceList`](internal-3.PriceList.md)[] + +#### Defined in + +packages/medusa/dist/models/customer-group.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Discount.md b/www/apps/docs/content/references/js-client/classes/internal-3.Discount.md new file mode 100644 index 0000000000..c5d55817e1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Discount.md @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Discount + +[internal](../modules/internal-3.md).Discount + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Discount`** + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### ends\_at + +• **ends\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:13 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:9 + +___ + +### is\_dynamic + +• **is\_dynamic**: `boolean` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:6 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:18 + +___ + +### parent\_discount + +• **parent\_discount**: [`Discount`](internal-3.Discount.md) + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:11 + +___ + +### parent\_discount\_id + +• **parent\_discount\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:10 + +___ + +### regions + +• **regions**: [`Region`](internal-3.Region.md)[] + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:15 + +___ + +### rule + +• **rule**: [`DiscountRule`](internal-3.DiscountRule.md) + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:8 + +___ + +### rule\_id + +• **rule\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:7 + +___ + +### starts\_at + +• **starts\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:12 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### upperCaseCodeAndTrim + +• `Private` **upperCaseCodeAndTrim**: `any` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:19 + +___ + +### usage\_count + +• **usage\_count**: `number` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:17 + +___ + +### usage\_limit + +• **usage\_limit**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:16 + +___ + +### valid\_duration + +• **valid\_duration**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/discount.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md b/www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md new file mode 100644 index 0000000000..f45d358370 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.DiscountCondition.md @@ -0,0 +1,181 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountCondition + +[internal](../modules/internal-3.md).DiscountCondition + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`DiscountCondition`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:30 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](internal-3.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:28 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### discount\_rule + +• **discount\_rule**: [`DiscountRule`](internal-3.DiscountRule.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:23 + +___ + +### discount\_rule\_id + +• **discount\_rule\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:22 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:29 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:21 + +___ + +### product\_collections + +• **product\_collections**: [`ProductCollection`](internal-3.ProductCollection.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:27 + +___ + +### product\_tags + +• **product\_tags**: [`ProductTag`](internal-3.ProductTag.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:26 + +___ + +### product\_types + +• **product\_types**: [`ProductType`](internal-3.ProductType.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:25 + +___ + +### products + +• **products**: [`Product`](internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:24 + +___ + +### type + +• **type**: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition.d.ts:20 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md new file mode 100644 index 0000000000..4c3c9298d1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.DiscountRule.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountRule + +[internal](../modules/internal-3.md).DiscountRule + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`DiscountRule`** + +## Properties + +### allocation + +• **allocation**: [`AllocationType`](../enums/internal-3.AllocationType.md) + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:16 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:19 + +___ + +### conditions + +• **conditions**: [`DiscountCondition`](internal-3.DiscountCondition.md)[] + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:13 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:18 + +___ + +### type + +• **type**: [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `number` + +#### Defined in + +packages/medusa/dist/models/discount-rule.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md b/www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md new file mode 100644 index 0000000000..6f5400b7a9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.DraftOrder.md @@ -0,0 +1,177 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DraftOrder + +[internal](../modules/internal-3.md).DraftOrder + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`DraftOrder`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:20 + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:15 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:12 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:11 + +___ + +### completed\_at + +• **completed\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:16 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:10 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:19 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:18 + +___ + +### no\_notification\_order + +• **no\_notification\_order**: `boolean` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:17 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:14 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:13 + +___ + +### status + +• **status**: [`DraftOrderStatus`](../enums/internal-3.DraftOrderStatus.md) + +#### Defined in + +packages/medusa/dist/models/draft-order.d.ts:9 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md b/www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md new file mode 100644 index 0000000000..8d19ebd8a1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Fulfillment.md @@ -0,0 +1,247 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Fulfillment + +[internal](../modules/internal-3.md).Fulfillment + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Fulfillment`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:27 + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:24 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal-3.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:10 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:9 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:22 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:26 + +___ + +### items + +• **items**: [`FulfillmentItem`](internal-3.FulfillmentItem.md)[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:19 + +___ + +### location\_id + +• **location\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:17 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:25 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:15 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:14 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:13 + +___ + +### provider + +• **provider**: [`FulfillmentProvider`](internal-3.FulfillmentProvider.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:18 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:16 + +___ + +### shipped\_at + +• **shipped\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:23 + +___ + +### swap + +• **swap**: [`Swap`](internal-3.Swap.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:12 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:11 + +___ + +### tracking\_links + +• **tracking\_links**: [`TrackingLink`](internal-3.TrackingLink.md)[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:20 + +___ + +### tracking\_numbers + +• **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/models/fulfillment.d.ts:21 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md b/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md new file mode 100644 index 0000000000..c9960dfe4b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentItem.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentItem + +[internal](../modules/internal-3.md).FulfillmentItem + +## Properties + +### fulfillment + +• **fulfillment**: [`Fulfillment`](internal-3.Fulfillment.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment-item.d.ts:6 + +___ + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment-item.d.ts:4 + +___ + +### item + +• **item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/fulfillment-item.d.ts:7 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/fulfillment-item.d.ts:5 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/fulfillment-item.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal.FulfillmentProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md similarity index 55% rename from www/apps/docs/content/references/js-client/classes/internal.FulfillmentProvider.md rename to www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md index 26095bd164..72156f8227 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.FulfillmentProvider.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.FulfillmentProvider.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Class: FulfillmentProvider -[internal](../modules/internal.md).FulfillmentProvider +[internal](../modules/internal-3.md).FulfillmentProvider ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/fulfillment-provider.d.ts:2 +packages/medusa/dist/models/fulfillment-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/fulfillment-provider.d.ts:3 +packages/medusa/dist/models/fulfillment-provider.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md b/www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md new file mode 100644 index 0000000000..b4e6736498 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.GiftCard.md @@ -0,0 +1,191 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCard + +[internal](../modules/internal-3.md).GiftCard + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`GiftCard`** + +## Properties + +### balance + +• **balance**: `number` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:7 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:16 + +___ + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### ends\_at + +• **ends\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:13 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:12 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:15 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:11 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:10 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:9 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:8 + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `number` + +#### Defined in + +packages/medusa/dist/models/gift-card.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md b/www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md new file mode 100644 index 0000000000..dc295cdcd8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.GiftCardTransaction.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCardTransaction + +[internal](../modules/internal-3.md).GiftCardTransaction + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:9 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:13 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:10 + +___ + +### gift\_card + +• **gift\_card**: [`GiftCard`](internal-3.GiftCard.md) + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:6 + +___ + +### gift\_card\_id + +• **gift\_card\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:4 + +___ + +### is\_taxable + +• **is\_taxable**: `boolean` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:11 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:8 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:7 + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/gift-card-transaction.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Image.md b/www/apps/docs/content/references/js-client/classes/internal-3.Image.md new file mode 100644 index 0000000000..17e3e4f980 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Image.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Image + +[internal](../modules/internal-3.md).Image + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Image`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/image.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/image.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### url + +• **url**: `string` + +#### Defined in + +packages/medusa/dist/models/image.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md b/www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md new file mode 100644 index 0000000000..c59c01d4dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.LineItem.md @@ -0,0 +1,495 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItem + +[internal](../modules/internal-3.md).LineItem + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`LineItem`** + +## Properties + +### adjustments + +• **adjustments**: [`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[] + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:20 + +___ + +### allow\_discounts + +• **allow\_discounts**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:30 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:51 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:12 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:11 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal-3.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:18 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:25 + +___ + +### discount\_total + +• `Optional` **discount\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:48 + +___ + +### fulfilled\_quantity + +• **fulfilled\_quantity**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:37 + +___ + +### gift\_card\_total + +• `Optional` **gift\_card\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:50 + +___ + +### has\_shipping + +• **has\_shipping**: ``null`` \| `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:31 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:41 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:28 + +___ + +### is\_return + +• **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:27 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:40 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:14 + +___ + +### order\_edit + +• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](internal-3.OrderEdit.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:23 + +___ + +### order\_edit\_id + +• `Optional` **order\_edit\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:22 + +___ + +### order\_id + +• **order\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:13 + +___ + +### original\_item\_id + +• `Optional` **original\_item\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:21 + +___ + +### original\_tax\_total + +• `Optional` **original\_tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:47 + +___ + +### original\_total + +• `Optional` **original\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:46 + +___ + +### product\_id + +• **product\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:35 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:36 + +___ + +### raw\_discount\_total + +• `Optional` **raw\_discount\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:49 + +___ + +### refundable + +• `Optional` **refundable**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:42 + +___ + +### returned\_quantity + +• **returned\_quantity**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:38 + +___ + +### shipped\_quantity + +• **shipped\_quantity**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:39 + +___ + +### should\_merge + +• **should\_merge**: `boolean` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:29 + +___ + +### subtotal + +• `Optional` **subtotal**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:43 + +___ + +### swap + +• **swap**: [`Swap`](internal-3.Swap.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:16 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:15 + +___ + +### tax\_lines + +• **tax\_lines**: [`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[] + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:19 + +___ + +### tax\_total + +• `Optional` **tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:44 + +___ + +### thumbnail + +• **thumbnail**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:26 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:24 + +___ + +### total + +• `Optional` **total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:45 + +___ + +### unit\_price + +• **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:32 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal-3.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:34 + +___ + +### variant\_id + +• **variant\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:33 + +## Methods + +### afterUpdateOrLoad + +▸ **afterUpdateOrLoad**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:53 + +___ + +### beforeUpdate + +▸ **beforeUpdate**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/models/line-item.d.ts:52 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md b/www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md new file mode 100644 index 0000000000..dded692bd3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.LineItemAdjustment.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemAdjustment + +[internal](../modules/internal-3.md).LineItemAdjustment + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:10 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:12 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:7 + +___ + +### discount + +• **discount**: [`Discount`](internal-3.Discount.md) + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:8 + +___ + +### discount\_id + +• **discount\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:9 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:4 + +___ + +### item + +• **item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:6 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/line-item-adjustment.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md b/www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md new file mode 100644 index 0000000000..4b01f456a0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.LineItemTaxLine.md @@ -0,0 +1,143 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemTaxLine + +[internal](../modules/internal-3.md).LineItemTaxLine + +Base abstract entity for all entities + +## Hierarchy + +- [`TaxLine`](internal-3.TaxLine.md) + + ↳ **`LineItemTaxLine`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/line-item-tax-line.d.ts:6 + +___ + +### code + +• **code**: ``null`` \| `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[code](internal-3.TaxLine.md#code) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[created_at](internal-3.TaxLine.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[id](internal-3.TaxLine.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### item + +• **item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/line-item-tax-line.d.ts:5 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/line-item-tax-line.d.ts:4 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[metadata](internal-3.TaxLine.md#metadata) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:6 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[name](internal-3.TaxLine.md#name) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:4 + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[rate](internal-3.TaxLine.md#rate) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:3 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[updated_at](internal-3.TaxLine.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md b/www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md new file mode 100644 index 0000000000..745661ada5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.MoneyAmount.md @@ -0,0 +1,221 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: MoneyAmount + +[internal](../modules/internal-3.md).MoneyAmount + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`MoneyAmount`** + +## Properties + +### afterLoad + +• `Private` **afterLoad**: `any` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:21 + +___ + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:9 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:19 + +___ + +### beforeUpdate + +• `Private` **beforeUpdate**: `any` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:20 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• `Optional` **currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:8 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:7 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### max\_quantity + +• **max\_quantity**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:11 + +___ + +### min\_quantity + +• **min\_quantity**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:10 + +___ + +### price\_list + +• **price\_list**: ``null`` \| [`PriceList`](internal-3.PriceList.md) + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:13 + +___ + +### price\_list\_id + +• **price\_list\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:12 + +___ + +### region + +• `Optional` **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:18 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:17 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal-3.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:15 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:16 + +___ + +### variants + +• **variants**: [`ProductVariant`](internal-3.ProductVariant.md)[] + +#### Defined in + +packages/medusa/dist/models/money-amount.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Order.md b/www/apps/docs/content/references/js-client/classes/internal-3.Order.md new file mode 100644 index 0000000000..b5705afb6f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Order.md @@ -0,0 +1,587 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Order + +[internal](../modules/internal-3.md).Order + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Order`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:101 + +___ + +### billing\_address + +• **billing\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:60 + +___ + +### billing\_address\_id + +• **billing\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:59 + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:82 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:55 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:54 + +___ + +### claims + +• **claims**: [`ClaimOrder`](internal-3.ClaimOrder.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:74 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:66 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:65 + +___ + +### customer + +• **customer**: [`Customer`](internal-3.Customer.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:57 + +___ + +### customer\_id + +• **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:56 + +___ + +### discount\_total + +• **discount\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:90 + +___ + +### discounts + +• **discounts**: [`Discount`](internal-3.Discount.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:68 + +___ + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:53 + +___ + +### draft\_order + +• **draft\_order**: [`DraftOrder`](internal-3.DraftOrder.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:78 + +___ + +### draft\_order\_id + +• **draft\_order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:77 + +___ + +### edits + +• **edits**: [`OrderEdit`](internal-3.OrderEdit.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:79 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:58 + +___ + +### external\_id + +• **external\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:86 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal-3.FulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:51 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal-3.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:72 + +___ + +### gift\_card\_tax\_total + +• **gift\_card\_tax\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:99 + +___ + +### gift\_card\_total + +• **gift\_card\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:98 + +___ + +### gift\_card\_transactions + +• **gift\_card\_transactions**: [`GiftCardTransaction`](internal-3.GiftCardTransaction.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:81 + +___ + +### gift\_cards + +• **gift\_cards**: [`GiftCard`](internal-3.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:69 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:85 + +___ + +### items + +• **items**: [`LineItem`](internal-3.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:80 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/order.d.ts:83 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:84 + +___ + +### object + +• `Readonly` **object**: ``"order"`` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:49 + +___ + +### paid\_total + +• **paid\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:96 + +___ + +### payment\_status + +• **payment\_status**: [`PaymentStatus`](../enums/internal-3.PaymentStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:52 + +___ + +### payments + +• **payments**: [`Payment`](internal-3.Payment.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:71 + +___ + +### raw\_discount\_total + +• **raw\_discount\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:91 + +___ + +### refundable\_amount + +• **refundable\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:97 + +___ + +### refunded\_total + +• **refunded\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:93 + +___ + +### refunds + +• **refunds**: [`Refund`](internal-3.Refund.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:75 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:64 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:63 + +___ + +### returnable\_items + +• `Optional` **returnable\_items**: [`LineItem`](internal-3.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:100 + +___ + +### returns + +• **returns**: [`Return`](internal-3.Return.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:73 + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](internal-3.SalesChannel.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:88 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:87 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:62 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:61 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal-3.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:70 + +___ + +### shipping\_total + +• **shipping\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:89 + +___ + +### status + +• **status**: [`OrderStatus`](../enums/internal-3.OrderStatus.md) + +#### Defined in + +packages/medusa/dist/models/order.d.ts:50 + +___ + +### subtotal + +• **subtotal**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:95 + +___ + +### swaps + +• **swaps**: [`Swap`](internal-3.Swap.md)[] + +#### Defined in + +packages/medusa/dist/models/order.d.ts:76 + +___ + +### tax\_rate + +• **tax\_rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:67 + +___ + +### tax\_total + +• **tax\_total**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:92 + +___ + +### total + +• **total**: `number` + +#### Defined in + +packages/medusa/dist/models/order.d.ts:94 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.OrderEdit.md b/www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md similarity index 53% rename from www/apps/docs/content/references/js-client/classes/internal.OrderEdit.md rename to www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md index 0bfa7ccae8..80ec2e7b12 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.OrderEdit.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.OrderEdit.md @@ -4,13 +4,13 @@ displayed_sidebar: jsClientSidebar # Class: OrderEdit -[internal](../modules/internal.md).OrderEdit +[internal](../modules/internal-3.md).OrderEdit Base abstract entity for all entities ## Hierarchy -- [`BaseEntity`](internal.BaseEntity.md) +- [`BaseEntity`](internal-1.BaseEntity.md) ↳ **`OrderEdit`** @@ -22,7 +22,7 @@ Base abstract entity for all entities #### Defined in -medusa/dist/models/order-edit.d.ts:37 +packages/medusa/dist/models/order-edit.d.ts:37 ___ @@ -32,7 +32,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:24 +packages/medusa/dist/models/order-edit.d.ts:24 ___ @@ -42,17 +42,17 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:23 +packages/medusa/dist/models/order-edit.d.ts:23 ___ ### changes -• **changes**: [`OrderItemChange`](internal.OrderItemChange.md)[] +• **changes**: [`OrderItemChange`](internal-3.OrderItemChange.md)[] #### Defined in -medusa/dist/models/order-edit.d.ts:13 +packages/medusa/dist/models/order-edit.d.ts:13 ___ @@ -62,7 +62,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:19 +packages/medusa/dist/models/order-edit.d.ts:19 ___ @@ -72,7 +72,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:18 +packages/medusa/dist/models/order-edit.d.ts:18 ___ @@ -82,11 +82,11 @@ ___ #### Inherited from -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:6 +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 ___ @@ -96,7 +96,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:15 +packages/medusa/dist/models/order-edit.d.ts:15 ___ @@ -106,7 +106,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:22 +packages/medusa/dist/models/order-edit.d.ts:22 ___ @@ -116,7 +116,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:20 +packages/medusa/dist/models/order-edit.d.ts:20 ___ @@ -126,7 +126,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:21 +packages/medusa/dist/models/order-edit.d.ts:21 ___ @@ -136,7 +136,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:35 +packages/medusa/dist/models/order-edit.d.ts:35 ___ @@ -146,7 +146,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:29 +packages/medusa/dist/models/order-edit.d.ts:29 ___ @@ -156,7 +156,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:34 +packages/medusa/dist/models/order-edit.d.ts:34 ___ @@ -166,7 +166,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:33 +packages/medusa/dist/models/order-edit.d.ts:33 ___ @@ -176,11 +176,11 @@ ___ #### Inherited from -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:5 +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 ___ @@ -190,27 +190,27 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:14 +packages/medusa/dist/models/order-edit.d.ts:14 ___ ### items -• **items**: [`LineItem`](internal.LineItem.md)[] +• **items**: [`LineItem`](internal-3.LineItem.md)[] #### Defined in -medusa/dist/models/order-edit.d.ts:25 +packages/medusa/dist/models/order-edit.d.ts:25 ___ ### order -• **order**: [`Order`](internal.Order.md) +• **order**: [`Order`](internal-3.Order.md) #### Defined in -medusa/dist/models/order-edit.d.ts:12 +packages/medusa/dist/models/order-edit.d.ts:12 ___ @@ -220,17 +220,17 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:11 +packages/medusa/dist/models/order-edit.d.ts:11 ___ ### payment\_collection -• **payment\_collection**: [`PaymentCollection`](internal.PaymentCollection.md) +• **payment\_collection**: [`PaymentCollection`](internal-3.PaymentCollection.md) #### Defined in -medusa/dist/models/order-edit.d.ts:27 +packages/medusa/dist/models/order-edit.d.ts:27 ___ @@ -240,7 +240,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:26 +packages/medusa/dist/models/order-edit.d.ts:26 ___ @@ -250,7 +250,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:17 +packages/medusa/dist/models/order-edit.d.ts:17 ___ @@ -260,7 +260,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:16 +packages/medusa/dist/models/order-edit.d.ts:16 ___ @@ -270,17 +270,17 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:28 +packages/medusa/dist/models/order-edit.d.ts:28 ___ ### status -• **status**: [`OrderEditStatus`](../enums/internal.OrderEditStatus.md) +• **status**: [`OrderEditStatus`](../enums/internal-3.OrderEditStatus.md) #### Defined in -medusa/dist/models/order-edit.d.ts:36 +packages/medusa/dist/models/order-edit.d.ts:36 ___ @@ -290,7 +290,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:32 +packages/medusa/dist/models/order-edit.d.ts:32 ___ @@ -300,7 +300,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:30 +packages/medusa/dist/models/order-edit.d.ts:30 ___ @@ -310,7 +310,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:31 +packages/medusa/dist/models/order-edit.d.ts:31 ___ @@ -320,11 +320,11 @@ ___ #### Inherited from -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) #### Defined in -medusa/dist/interfaces/models/base-entity.d.ts:7 +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 ## Methods @@ -338,4 +338,4 @@ medusa/dist/interfaces/models/base-entity.d.ts:7 #### Defined in -medusa/dist/models/order-edit.d.ts:38 +packages/medusa/dist/models/order-edit.d.ts:38 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md b/www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md new file mode 100644 index 0000000000..e0caf2d05a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.OrderItemChange.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderItemChange + +[internal](../modules/internal-3.md).OrderItemChange + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`OrderItemChange`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### line\_item + +• `Optional` **line\_item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:16 + +___ + +### line\_item\_id + +• `Optional` **line\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:15 + +___ + +### order\_edit + +• **order\_edit**: [`OrderEdit`](internal-3.OrderEdit.md) + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:12 + +___ + +### order\_edit\_id + +• **order\_edit\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:11 + +___ + +### original\_line\_item + +• `Optional` **original\_line\_item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:14 + +___ + +### original\_line\_item\_id + +• `Optional` **original\_line\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:13 + +___ + +### type + +• **type**: [`OrderEditItemChangeType`](../enums/internal-3.OrderEditItemChangeType.md) + +#### Defined in + +packages/medusa/dist/models/order-item-change.d.ts:10 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Payment.md b/www/apps/docs/content/references/js-client/classes/internal-3.Payment.md new file mode 100644 index 0000000000..29837fc7e1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Payment.md @@ -0,0 +1,227 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Payment + +[internal](../modules/internal-3.md).Payment + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Payment`** + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:13 + +___ + +### amount\_refunded + +• **amount\_refunded**: `number` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:16 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:23 + +___ + +### canceled\_at + +• **canceled\_at**: `string` \| `Date` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:20 + +___ + +### captured\_at + +• **captured\_at**: `string` \| `Date` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:19 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:10 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:9 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:15 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:14 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:18 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:22 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:21 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:12 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:11 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:17 + +___ + +### swap + +• **swap**: [`Swap`](internal-3.Swap.md) + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:8 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md new file mode 100644 index 0000000000..73f4fb6243 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentCollection.md @@ -0,0 +1,211 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentCollection + +[internal](../modules/internal-3.md).PaymentCollection + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`PaymentCollection`** + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:17 + +___ + +### authorized\_amount + +• **authorized\_amount**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:18 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:27 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### created\_by + +• **created\_by**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:26 + +___ + +### currency + +• **currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:22 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:21 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:16 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:25 + +___ + +### payment\_sessions + +• **payment\_sessions**: [`PaymentSession`](internal-3.PaymentSession.md)[] + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:23 + +___ + +### payments + +• **payments**: [`Payment`](internal-3.Payment.md)[] + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:24 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:20 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:19 + +___ + +### status + +• **status**: [`PaymentCollectionStatus`](../enums/internal-3.PaymentCollectionStatus.md) + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:15 + +___ + +### type + +• **type**: [`ORDER_EDIT`](../modules/internal-3.md#order_edit) + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.PaymentProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md similarity index 57% rename from www/apps/docs/content/references/js-client/classes/internal.PaymentProvider.md rename to www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md index 5a0f19fe55..2aa0bcebda 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.PaymentProvider.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentProvider.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Class: PaymentProvider -[internal](../modules/internal.md).PaymentProvider +[internal](../modules/internal-3.md).PaymentProvider ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/payment-provider.d.ts:2 +packages/medusa/dist/models/payment-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/payment-provider.d.ts:3 +packages/medusa/dist/models/payment-provider.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md new file mode 100644 index 0000000000..595db711d0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.PaymentSession.md @@ -0,0 +1,167 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentSession + +[internal](../modules/internal-3.md).PaymentSession + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`PaymentSession`** + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:19 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:21 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:12 + +___ + +### cart\_id + +• **cart\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:11 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:17 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:18 + +___ + +### is\_initiated + +• **is\_initiated**: `boolean` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:15 + +___ + +### is\_selected + +• **is\_selected**: ``null`` \| `boolean` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:14 + +___ + +### payment\_authorized\_at + +• **payment\_authorized\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:20 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:13 + +___ + +### status + +• **status**: `string` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:16 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md b/www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md new file mode 100644 index 0000000000..e91441a555 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.PriceList.md @@ -0,0 +1,171 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PriceList + +[internal](../modules/internal-3.md).PriceList + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`PriceList`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:15 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer\_groups + +• **customer\_groups**: [`CustomerGroup`](internal-3.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:12 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:7 + +___ + +### ends\_at + +• **ends\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:11 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:14 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:6 + +___ + +### prices + +• **prices**: [`MoneyAmount`](internal-3.MoneyAmount.md)[] + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:13 + +___ + +### starts\_at + +• **starts\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:10 + +___ + +### status + +• **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:9 + +___ + +### type + +• **type**: [`PriceListType`](../enums/internal-3.PriceListType.md) + +#### Defined in + +packages/medusa/dist/models/price-list.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Product.md b/www/apps/docs/content/references/js-client/classes/internal-3.Product.md new file mode 100644 index 0000000000..74e67f05af --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Product.md @@ -0,0 +1,411 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Product + +[internal](../modules/internal-3.md).Product + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Product`** + +## Properties + +### afterLoad + +• `Private` **afterLoad**: `any` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:51 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:49 + +___ + +### beforeUpdate + +• `Private` **beforeUpdate**: `any` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:50 + +___ + +### categories + +• **categories**: [`ProductCategory`](internal-3.ProductCategory.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:28 + +___ + +### collection + +• **collection**: [`ProductCollection`](internal-3.ProductCollection.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:41 + +___ + +### collection\_id + +• **collection\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:40 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:20 + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:45 + +___ + +### external\_id + +• **external\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:46 + +___ + +### handle + +• **handle**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:21 + +___ + +### height + +• **height**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:34 + +___ + +### hs\_code + +• **hs\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:36 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### images + +• **images**: [`Image`](internal-3.Image.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:24 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:22 + +___ + +### length + +• **length**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:33 + +___ + +### material + +• **material**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:39 + +___ + +### metadata + +• **metadata**: ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product.d.ts:47 + +___ + +### mid\_code + +• **mid\_code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:38 + +___ + +### options + +• **options**: [`ProductOption`](internal-3.ProductOption.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:26 + +___ + +### origin\_country + +• **origin\_country**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:37 + +___ + +### profile + +• **profile**: [`ShippingProfile`](internal-3.ShippingProfile.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:30 + +___ + +### profile\_id + +• **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:29 + +___ + +### profiles + +• **profiles**: [`ShippingProfile`](internal-3.ShippingProfile.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:31 + +___ + +### sales\_channels + +• **sales\_channels**: [`SalesChannel`](internal-3.SalesChannel.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:48 + +___ + +### status + +• **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:23 + +___ + +### subtitle + +• **subtitle**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:19 + +___ + +### tags + +• **tags**: [`ProductTag`](internal-3.ProductTag.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:44 + +___ + +### thumbnail + +• **thumbnail**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:25 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:18 + +___ + +### type + +• **type**: [`ProductType`](internal-3.ProductType.md) + +#### Defined in + +packages/medusa/dist/models/product.d.ts:43 + +___ + +### type\_id + +• **type\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:42 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variants + +• **variants**: [`ProductVariant`](internal-3.ProductVariant.md)[] + +#### Defined in + +packages/medusa/dist/models/product.d.ts:27 + +___ + +### weight + +• **weight**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:32 + +___ + +### width + +• **width**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/product.d.ts:35 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md new file mode 100644 index 0000000000..9a2466981e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductCategory.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCategory + +[internal](../modules/internal-3.md).ProductCategory + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`ProductCategory`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:16 + +___ + +### category\_children + +• **category\_children**: [`ProductCategory`](internal-3.ProductCategory.md)[] + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:13 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:7 + +___ + +### handle + +• **handle**: `string` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:8 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_active + +• **is\_active**: [`Boolean`](../modules/internal-3.md#boolean) + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:9 + +___ + +### is\_internal + +• **is\_internal**: [`Boolean`](../modules/internal-3.md#boolean) + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:10 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:6 + +___ + +### parent\_category + +• **parent\_category**: ``null`` \| [`ProductCategory`](internal-3.ProductCategory.md) + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:11 + +___ + +### parent\_category\_id + +• **parent\_category\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:12 + +___ + +### products + +• **products**: [`Product`](internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:15 + +___ + +### rank + +• **rank**: `number` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### productCategoryProductJoinTable + +▪ `Static` **productCategoryProductJoinTable**: `string` + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:4 + +___ + +### treeRelations + +▪ `Static` **treeRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/models/product-category.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md new file mode 100644 index 0000000000..7a661ec916 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductCollection.md @@ -0,0 +1,121 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCollection + +[internal](../modules/internal-3.md).ProductCollection + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductCollection`** + +## Properties + +### createHandleIfNotProvided + +• `Private` **createHandleIfNotProvided**: `any` + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:8 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### handle + +• **handle**: `string` + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:7 + +___ + +### products + +• **products**: [`Product`](internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:6 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product-collection.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md new file mode 100644 index 0000000000..807ccebcf1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductOption.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOption + +[internal](../modules/internal-3.md).ProductOption + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductOption`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:10 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:9 + +___ + +### product + +• **product**: [`Product`](internal-3.Product.md) + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:8 + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:7 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### values + +• **values**: [`ProductOptionValue`](internal-3.ProductOptionValue.md)[] + +#### Defined in + +packages/medusa/dist/models/product-option.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md new file mode 100644 index 0000000000..6749e6af69 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductOptionValue.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOptionValue + +[internal](../modules/internal-3.md).ProductOptionValue + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductOptionValue`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:11 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:10 + +___ + +### option + +• **option**: [`ProductOption`](internal-3.ProductOption.md) + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:7 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:6 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:5 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal-3.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:9 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-option-value.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md new file mode 100644 index 0000000000..494fed2cb5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductTag.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTag + +[internal](../modules/internal-3.md).ProductTag + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductTag`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-tag.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-tag.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/product-tag.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md new file mode 100644 index 0000000000..79587e9ef9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductType.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductType + +[internal](../modules/internal-3.md).ProductType + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductType`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-type.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-type.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/product-type.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md new file mode 100644 index 0000000000..709522f50e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariant.md @@ -0,0 +1,321 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariant + +[internal](../modules/internal-3.md).ProductVariant + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductVariant`** + +## Properties + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:17 + +___ + +### barcode + +• **barcode**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:12 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:31 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### ean + +• **ean**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:13 + +___ + +### height + +• **height**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:25 + +___ + +### hs\_code + +• **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:19 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### inventory\_items + +• **inventory\_items**: [`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[] + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:28 + +___ + +### inventory\_quantity + +• **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:16 + +___ + +### length + +• **length**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:24 + +___ + +### manage\_inventory + +• **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:18 + +___ + +### material + +• **material**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:22 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:29 + +___ + +### mid\_code + +• **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:21 + +___ + +### options + +• **options**: [`ProductOptionValue`](internal-3.ProductOptionValue.md)[] + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:27 + +___ + +### origin\_country + +• **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:20 + +___ + +### prices + +• **prices**: [`MoneyAmount`](internal-3.MoneyAmount.md)[] + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:10 + +___ + +### product + +• **product**: [`Product`](internal-3.Product.md) + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:9 + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:8 + +___ + +### purchasable + +• `Optional` **purchasable**: `boolean` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:30 + +___ + +### sku + +• **sku**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:11 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:7 + +___ + +### upc + +• **upc**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:14 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant\_rank + +• **variant\_rank**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:15 + +___ + +### weight + +• **weight**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:23 + +___ + +### width + +• **width**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant.d.ts:26 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md b/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md new file mode 100644 index 0000000000..5f99661a6d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ProductVariantInventoryItem.md @@ -0,0 +1,121 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantInventoryItem + +[internal](../modules/internal-3.md).ProductVariantInventoryItem + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductVariantInventoryItem`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-variant-inventory-item.d.ts:8 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### inventory\_item\_id + +• **inventory\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant-inventory-item.d.ts:4 + +___ + +### required\_quantity + +• **required\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/product-variant-inventory-item.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant + +• **variant**: [`ProductVariant`](internal-3.ProductVariant.md) + +#### Defined in + +packages/medusa/dist/models/product-variant-inventory-item.d.ts:6 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant-inventory-item.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Refund.md b/www/apps/docs/content/references/js-client/classes/internal-3.Refund.md new file mode 100644 index 0000000000..09dad5217e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Refund.md @@ -0,0 +1,157 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Refund + +[internal](../modules/internal-3.md).Refund + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Refund`** + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:16 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:21 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:20 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:19 + +___ + +### note + +• **note**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:17 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:14 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:12 + +___ + +### payment + +• **payment**: [`Payment`](internal-3.Payment.md) + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:15 + +___ + +### payment\_id + +• **payment\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:13 + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +packages/medusa/dist/models/refund.d.ts:18 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Region.md b/www/apps/docs/content/references/js-client/classes/internal-3.Region.md new file mode 100644 index 0000000000..7c97c3d3ed --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Region.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Region + +[internal](../modules/internal-3.md).Region + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Region`** + +## Properties + +### automatic\_taxes + +• **automatic\_taxes**: `boolean` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:16 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:24 + +___ + +### countries + +• **countries**: [`Country`](internal-3.Country.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currency + +• **currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/region.d.ts:11 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:10 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: [`FulfillmentProvider`](internal-3.FulfillmentProvider.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:21 + +___ + +### gift\_cards\_taxable + +• **gift\_cards\_taxable**: `boolean` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:15 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:23 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/region.d.ts:22 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:9 + +___ + +### payment\_providers + +• **payment\_providers**: [`PaymentProvider`](internal-3.PaymentProvider.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:20 + +___ + +### tax\_code + +• **tax\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:14 + +___ + +### tax\_provider + +• **tax\_provider**: [`TaxProvider`](internal-3.TaxProvider.md) + +#### Defined in + +packages/medusa/dist/models/region.d.ts:19 + +___ + +### tax\_provider\_id + +• **tax\_provider\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:18 + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +packages/medusa/dist/models/region.d.ts:12 + +___ + +### tax\_rates + +• **tax\_rates**: ``null`` \| [`TaxRate`](internal-3.TaxRate.md)[] + +#### Defined in + +packages/medusa/dist/models/region.d.ts:13 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Return.md b/www/apps/docs/content/references/js-client/classes/internal-3.Return.md new file mode 100644 index 0000000000..6362cb65ff --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Return.md @@ -0,0 +1,227 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Return + +[internal](../modules/internal-3.md).Return + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Return`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:30 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal-3.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:19 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:18 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:29 + +___ + +### items + +• **items**: [`ReturnItem`](internal-3.ReturnItem.md)[] + +#### Defined in + +packages/medusa/dist/models/return.d.ts:15 + +___ + +### location\_id + +• **location\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:23 + +___ + +### metadata + +• **metadata**: ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return.d.ts:28 + +___ + +### no\_notification + +• **no\_notification**: ``null`` \| `boolean` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:27 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:21 + +___ + +### order\_id + +• **order\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:20 + +___ + +### received\_at + +• **received\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:26 + +___ + +### refund\_amount + +• **refund\_amount**: `number` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:25 + +___ + +### shipping\_data + +• **shipping\_data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return.d.ts:24 + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](internal-3.ShippingMethod.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:22 + +___ + +### status + +• **status**: [`ReturnStatus`](../enums/internal-3.ReturnStatus.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:14 + +___ + +### swap + +• **swap**: [`Swap`](internal-3.Swap.md) + +#### Defined in + +packages/medusa/dist/models/return.d.ts:17 + +___ + +### swap\_id + +• **swap\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return.d.ts:16 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md new file mode 100644 index 0000000000..55d9d94b51 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ReturnItem.md @@ -0,0 +1,127 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnItem + +[internal](../modules/internal-3.md).ReturnItem + +## Properties + +### is\_requested + +• **is\_requested**: `boolean` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:10 + +___ + +### item + +• **item**: [`LineItem`](internal-3.LineItem.md) + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:8 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:6 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:16 + +___ + +### note + +• **note**: `string` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:15 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:9 + +___ + +### reason + +• **reason**: [`ReturnReason`](internal-3.ReturnReason.md) + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:14 + +___ + +### reason\_id + +• **reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:13 + +___ + +### received\_quantity + +• **received\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:12 + +___ + +### requested\_quantity + +• **requested\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:11 + +___ + +### return\_id + +• **return\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:5 + +___ + +### return\_order + +• **return\_order**: [`Return`](internal-3.Return.md) + +#### Defined in + +packages/medusa/dist/models/return-item.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md b/www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md new file mode 100644 index 0000000000..e49c6f5565 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ReturnReason.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnReason + +[internal](../modules/internal-3.md).ReturnReason + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ReturnReason`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:10 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### label + +• **label**: `string` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:4 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:9 + +___ + +### parent\_return\_reason + +• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](internal-3.ReturnReason.md) + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:7 + +___ + +### parent\_return\_reason\_id + +• **parent\_return\_reason\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:6 + +___ + +### return\_reason\_children + +• **return\_reason\_children**: [`ReturnReason`](internal-3.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:8 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/return-reason.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md b/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md new file mode 100644 index 0000000000..9bfaaf395e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannel.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannel + +[internal](../modules/internal-3.md).SalesChannel + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`SalesChannel`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:9 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### description + +• **description**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:6 + +___ + +### locations + +• **locations**: [`SalesChannelLocation`](internal-3.SalesChannelLocation.md)[] + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:8 + +___ + +### metadata + +• **metadata**: ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:7 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/sales-channel.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md b/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md new file mode 100644 index 0000000000..9f81b46b23 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.SalesChannelLocation.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannelLocation + +[internal](../modules/internal-3.md).SalesChannelLocation + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`SalesChannelLocation`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/sales-channel-location.d.ts:7 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### location\_id + +• **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/sales-channel-location.d.ts:5 + +___ + +### sales\_channel + +• **sales\_channel**: [`SalesChannel`](internal-3.SalesChannel.md) + +#### Defined in + +packages/medusa/dist/models/sales-channel-location.d.ts:6 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/sales-channel-location.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md new file mode 100644 index 0000000000..cfd79d02c4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethod.md @@ -0,0 +1,217 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethod + +[internal](../modules/internal-3.md).ShippingMethod + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:29 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:16 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:15 + +___ + +### claim\_order + +• **claim\_order**: [`ClaimOrder`](internal-3.ClaimOrder.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:14 + +___ + +### claim\_order\_id + +• **claim\_order\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:13 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:24 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:9 + +___ + +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:25 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:12 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:11 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:23 + +___ + +### return\_id + +• **return\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:19 + +___ + +### return\_order + +• **return\_order**: [`Return`](internal-3.Return.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:20 + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](internal-3.ShippingOption.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:21 + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:10 + +___ + +### subtotal + +• `Optional` **subtotal**: `number` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:26 + +___ + +### swap + +• **swap**: [`Swap`](internal-3.Swap.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:18 + +___ + +### swap\_id + +• **swap\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:17 + +___ + +### tax\_lines + +• **tax\_lines**: [`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:22 + +___ + +### tax\_total + +• `Optional` **tax\_total**: `number` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:28 + +___ + +### total + +• `Optional` **total**: `number` + +#### Defined in + +packages/medusa/dist/models/shipping-method.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md new file mode 100644 index 0000000000..7aa2bf415c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingMethodTaxLine.md @@ -0,0 +1,143 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethodTaxLine + +[internal](../modules/internal-3.md).ShippingMethodTaxLine + +Base abstract entity for all entities + +## Hierarchy + +- [`TaxLine`](internal-3.TaxLine.md) + + ↳ **`ShippingMethodTaxLine`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-method-tax-line.d.ts:6 + +___ + +### code + +• **code**: ``null`` \| `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[code](internal-3.TaxLine.md#code) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[created_at](internal-3.TaxLine.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[id](internal-3.TaxLine.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[metadata](internal-3.TaxLine.md#metadata) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:6 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[name](internal-3.TaxLine.md#name) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:4 + +___ + +### rate + +• **rate**: `number` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[rate](internal-3.TaxLine.md#rate) + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:3 + +___ + +### shipping\_method + +• **shipping\_method**: [`ShippingMethod`](internal-3.ShippingMethod.md) + +#### Defined in + +packages/medusa/dist/models/shipping-method-tax-line.d.ts:5 + +___ + +### shipping\_method\_id + +• **shipping\_method\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-method-tax-line.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[TaxLine](internal-3.TaxLine.md).[updated_at](internal-3.TaxLine.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md new file mode 100644 index 0000000000..f32c764fec --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOption.md @@ -0,0 +1,231 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingOption + +[internal](../modules/internal-3.md).ShippingOption + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ShippingOption`** + +## Properties + +### admin\_only + +• **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:21 + +___ + +### amount + +• **amount**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:19 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:26 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:23 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### includes\_tax + +• **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:25 + +___ + +### is\_return + +• **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:20 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:24 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:11 + +___ + +### price\_type + +• **price\_type**: [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:18 + +___ + +### profile + +• **profile**: [`ShippingProfile`](internal-3.ShippingProfile.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:15 + +___ + +### profile\_id + +• **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:14 + +___ + +### provider + +• **provider**: [`FulfillmentProvider`](internal-3.FulfillmentProvider.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:17 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:16 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:13 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:12 + +___ + +### requirements + +• **requirements**: [`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-option.d.ts:22 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md new file mode 100644 index 0000000000..5b0ad9a408 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingOptionRequirement.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingOptionRequirement + +[internal](../modules/internal-3.md).ShippingOptionRequirement + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:11 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:13 + +___ + +### deleted\_at + +• **deleted\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:12 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:7 + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](internal-3.ShippingOption.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:9 + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:8 + +___ + +### type + +• **type**: [`RequirementType`](../enums/internal-3.RequirementType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-option-requirement.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md new file mode 100644 index 0000000000..33c3b45d25 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.ShippingProfile.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingProfile + +[internal](../modules/internal-3.md).ShippingProfile + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ShippingProfile`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:15 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:14 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:10 + +___ + +### products + +• **products**: [`Product`](internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:12 + +___ + +### shipping\_options + +• **shipping\_options**: [`ShippingOption`](internal-3.ShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:13 + +___ + +### type + +• **type**: [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) + +#### Defined in + +packages/medusa/dist/models/shipping-profile.d.ts:11 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.Swap.md b/www/apps/docs/content/references/js-client/classes/internal-3.Swap.md new file mode 100644 index 0000000000..fc21b640b8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.Swap.md @@ -0,0 +1,281 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Swap + +[internal](../modules/internal-3.md).Swap + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Swap`** + +## Properties + +### additional\_items + +• **additional\_items**: [`LineItem`](internal-3.LineItem.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:34 + +___ + +### allow\_backorder + +• **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:47 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:50 + +___ + +### canceled\_at + +• **canceled\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:45 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:43 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:42 + +___ + +### confirmed\_at + +• **confirmed\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:44 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### difference\_due + +• **difference\_due**: `number` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:38 + +___ + +### fulfillment\_status + +• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/internal-3.SwapFulfillmentStatus.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:30 + +___ + +### fulfillments + +• **fulfillments**: [`Fulfillment`](internal-3.Fulfillment.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:36 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:48 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:49 + +___ + +### no\_notification + +• **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:46 + +___ + +### order + +• **order**: [`Order`](internal-3.Order.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:33 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:32 + +___ + +### payment + +• **payment**: [`Payment`](internal-3.Payment.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:37 + +___ + +### payment\_status + +• **payment\_status**: [`SwapPaymentStatus`](../enums/internal-3.SwapPaymentStatus.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:31 + +___ + +### return\_order + +• **return\_order**: [`Return`](internal-3.Return.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:35 + +___ + +### shipping\_address + +• **shipping\_address**: [`Address`](internal-3.Address.md) + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:40 + +___ + +### shipping\_address\_id + +• **shipping\_address\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:39 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal-3.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/models/swap.d.ts:41 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md b/www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md new file mode 100644 index 0000000000..be1ea55197 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.TaxLine.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxLine + +[internal](../modules/internal-3.md).TaxLine + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`TaxLine`** + + ↳↳ [`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) + + ↳↳ [`LineItemTaxLine`](internal-3.LineItemTaxLine.md) + +## Properties + +### code + +• **code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:6 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:4 + +___ + +### rate + +• **rate**: `number` + +#### Defined in + +packages/medusa/dist/models/tax-line.d.ts:3 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.TaxProvider.md b/www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md similarity index 58% rename from www/apps/docs/content/references/js-client/classes/internal.TaxProvider.md rename to www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md index b197e6c830..e5106c474f 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.TaxProvider.md +++ b/www/apps/docs/content/references/js-client/classes/internal-3.TaxProvider.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Class: TaxProvider -[internal](../modules/internal.md).TaxProvider +[internal](../modules/internal-3.md).TaxProvider ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/tax-provider.d.ts:2 +packages/medusa/dist/models/tax-provider.d.ts:2 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/tax-provider.d.ts:3 +packages/medusa/dist/models/tax-provider.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md b/www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md new file mode 100644 index 0000000000..53c4642e1b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.TaxRate.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxRate + +[internal](../modules/internal-3.md).TaxRate + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`TaxRate`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:19 + +___ + +### code + +• **code**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:8 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:12 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:9 + +___ + +### product\_count + +• `Optional` **product\_count**: `number` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:16 + +___ + +### product\_type\_count + +• `Optional` **product\_type\_count**: `number` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:17 + +___ + +### product\_types + +• **product\_types**: [`ProductType`](internal-3.ProductType.md)[] + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:14 + +___ + +### products + +• **products**: [`Product`](internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:13 + +___ + +### rate + +• **rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:7 + +___ + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:11 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:10 + +___ + +### shipping\_option\_count + +• `Optional` **shipping\_option\_count**: `number` + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:18 + +___ + +### shipping\_options + +• **shipping\_options**: [`ShippingOption`](internal-3.ShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/models/tax-rate.d.ts:15 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-3.TrackingLink.md b/www/apps/docs/content/references/js-client/classes/internal-3.TrackingLink.md new file mode 100644 index 0000000000..5b69e0c3e9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-3.TrackingLink.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TrackingLink + +[internal](../modules/internal-3.md).TrackingLink + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`TrackingLink`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:10 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### fulfillment + +• **fulfillment**: [`Fulfillment`](internal-3.Fulfillment.md) + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:7 + +___ + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:6 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:8 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:9 + +___ + +### tracking\_number + +• **tracking\_number**: `string` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### url + +• **url**: `string` + +#### Defined in + +packages/medusa/dist/models/tracking-link.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md deleted file mode 100644 index e9aeb5c1d1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateProductTypesParams - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductTypesParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:100 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md deleted file mode 100644 index 047f9fcbc4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateProductTypesReq - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductTypesReq - -## Properties - -### product\_types - -• **product\_types**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md deleted file mode 100644 index aa16de6379..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateProductsParams - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductsParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:100 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md deleted file mode 100644 index 5dd3774f67..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateProductsReq - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateProductsReq - -## Properties - -### products - -• **products**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md deleted file mode 100644 index db021b6e86..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:100 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md deleted file mode 100644 index fb87475a2e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq - -[internal](../modules/internal-30.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq - -## Properties - -### shipping\_options - -• **shipping\_options**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md deleted file mode 100644 index 5a9ffb8256..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesParams.md +++ /dev/null @@ -1,83 +0,0 @@ -# Class: AdminGetTaxRatesParams - -[internal](../modules/internal-30.md).AdminGetTaxRatesParams - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:124 - -___ - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:128 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:129 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:127 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:123 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:126 - -___ - -### rate - -• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:125 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:122 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md deleted file mode 100644 index f5f30a2c77..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminGetTaxRatesTaxRateParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminGetTaxRatesTaxRateParams - -[internal](../modules/internal-30.md).AdminGetTaxRatesTaxRateParams - -## Properties - -### expand - -• `Optional` **expand**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:74 - -___ - -### fields - -• `Optional` **fields**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md deleted file mode 100644 index 6bd504c154..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: AdminPostTaxRatesReq - -[internal](../modules/internal-30.md).AdminPostTaxRatesReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:120 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:121 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:126 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:124 - -___ - -### rate - -• `Optional` **rate**: ``null`` \| `number` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:123 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:122 - -___ - -### shipping\_options - -• `Optional` **shipping\_options**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:125 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md deleted file mode 100644 index b34edfb827..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostTaxRatesTaxRateProductTypesReq - -[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateProductTypesReq - -## Properties - -### product\_types - -• **product\_types**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md deleted file mode 100644 index d8a4a23f54..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostTaxRatesTaxRateProductsReq - -[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateProductsReq - -## Properties - -### products - -• **products**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md deleted file mode 100644 index 1496dd17cc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: AdminPostTaxRatesTaxRateReq - -[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateReq - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:113 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:114 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:119 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:117 - -___ - -### rate - -• `Optional` **rate**: ``null`` \| `number` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:116 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:115 - -___ - -### shipping\_options - -• `Optional` **shipping\_options**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md deleted file mode 100644 index 15392d4796..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostTaxRatesTaxRateShippingOptionsReq - -[internal](../modules/internal-30.md).AdminPostTaxRatesTaxRateShippingOptionsReq - -## Properties - -### shipping\_options - -• **shipping\_options**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md deleted file mode 100644 index 5352eeb119..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-30.NumericalComparisonOperator.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: NumericalComparisonOperator - -[internal](../modules/internal-30.md).NumericalComparisonOperator - -## Properties - -### gt - -• `Optional` **gt**: `number` - -#### Defined in - -medusa/dist/types/common.d.ts:86 - -___ - -### gte - -• `Optional` **gte**: `number` - -#### Defined in - -medusa/dist/types/common.d.ts:87 - -___ - -### lt - -• `Optional` **lt**: `number` - -#### Defined in - -medusa/dist/types/common.d.ts:85 - -___ - -### lte - -• `Optional` **lte**: `number` - -#### Defined in - -medusa/dist/types/common.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md b/www/apps/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md deleted file mode 100644 index 8ae33e5199..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-31.AdminDeleteUploadsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteUploadsReq - -[internal](../modules/internal-31.md).AdminDeleteUploadsReq - -## Properties - -### file\_key - -• **file\_key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/delete-upload.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md b/www/apps/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md deleted file mode 100644 index 5dfa7cc702..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-31.AdminPostUploadsDownloadUrlReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostUploadsDownloadUrlReq - -[internal](../modules/internal-31.md).AdminPostUploadsDownloadUrlReq - -## Properties - -### file\_key - -• **file\_key**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/get-download-url.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md b/www/apps/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md deleted file mode 100644 index f688b92c76..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-31.IAdminPostUploadsFileReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: IAdminPostUploadsFileReq - -[internal](../modules/internal-31.md).IAdminPostUploadsFileReq - -## Properties - -### originalName - -• **originalName**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/create-upload.d.ts:73 - -___ - -### path - -• **path**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/uploads/create-upload.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md b/www/apps/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md deleted file mode 100644 index 5f0e415a59..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-32.AdminCreateUserRequest.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminCreateUserRequest - -[internal](../modules/internal-32.md).AdminCreateUserRequest - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/create-user.d.ts:90 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/create-user.d.ts:91 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/create-user.d.ts:92 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/create-user.d.ts:94 - -___ - -### role - -• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) - -#### Defined in - -medusa/dist/api/routes/admin/users/create-user.d.ts:93 diff --git a/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md b/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md deleted file mode 100644 index 078d703426..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordRequest.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminResetPasswordRequest - -[internal](../modules/internal-32.md).AdminResetPasswordRequest - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/reset-password.d.ts:87 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/reset-password.d.ts:89 - -___ - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/reset-password.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md b/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md deleted file mode 100644 index ccc035552d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-32.AdminResetPasswordTokenRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminResetPasswordTokenRequest - -[internal](../modules/internal-32.md).AdminResetPasswordTokenRequest - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/reset-password-token.d.ts:68 diff --git a/www/apps/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md b/www/apps/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md deleted file mode 100644 index d6565e5511..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-32.AdminUpdateUserRequest.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminUpdateUserRequest - -[internal](../modules/internal-32.md).AdminUpdateUserRequest - -## Properties - -### api\_token - -• `Optional` **api\_token**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/update-user.d.ts:88 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/update-user.d.ts:85 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/users/update-user.d.ts:86 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/users/update-user.d.ts:89 - -___ - -### role - -• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) - -#### Defined in - -medusa/dist/api/routes/admin/users/update-user.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md b/www/apps/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md deleted file mode 100644 index a6a71121f3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-33.AdminGetVariantsParams.md +++ /dev/null @@ -1,145 +0,0 @@ -# Class: AdminGetVariantsParams - -[internal](../modules/internal-33.md).AdminGetVariantsParams - -## Hierarchy - -- [`AdminPriceSelectionParams`](internal-33.AdminPriceSelectionParams.md) - - ↳ **`AdminGetVariantsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[cart_id](internal-33.AdminPriceSelectionParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[currency_code](internal-33.AdminPriceSelectionParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Inherited from - -[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[customer_id](internal-33.AdminPriceSelectionParams.md#customer_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:7 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:116 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:117 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:118 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:120 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:114 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:115 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:113 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[AdminPriceSelectionParams](internal-33.AdminPriceSelectionParams.md).[region_id](internal-33.AdminPriceSelectionParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 - -___ - -### title - -• `Optional` **title**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/variants/list-variants.d.ts:119 diff --git a/www/apps/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md b/www/apps/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md deleted file mode 100644 index 5d2755e08b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-33.AdminPriceSelectionParams.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: AdminPriceSelectionParams - -[internal](../modules/internal-33.md).AdminPriceSelectionParams - -## Hierarchy - -- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) - - ↳ **`AdminPriceSelectionParams`** - - ↳↳ [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -medusa/dist/types/price-selection.d.ts:7 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md b/www/apps/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md deleted file mode 100644 index 6505a0dea1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-33.PriceSelectionParams.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: PriceSelectionParams - -[internal](../modules/internal-33.md).PriceSelectionParams - -## Hierarchy - -- **`PriceSelectionParams`** - - ↳ [`AdminPriceSelectionParams`](internal-33.AdminPriceSelectionParams.md) - - ↳ [`StoreGetVariantsParams`](internal-45.StoreGetVariantsParams.md) - - ↳ [`StoreGetProductsPaginationParams`](internal-46.StoreGetProductsPaginationParams.md) - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md b/www/apps/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md deleted file mode 100644 index 73b4f5081e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-34.StorePostAuthReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: StorePostAuthReq - -[internal](../modules/internal-34.md).StorePostAuthReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/auth/create-session.d.ts:59 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/auth/create-session.d.ts:60 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.Discount.md b/www/apps/docs/content/references/js-client/classes/internal-35.Discount.md deleted file mode 100644 index 2a2a3dc905..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.Discount.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: Discount - -[internal](../modules/internal-35.md).Discount - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:123 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.GiftCard.md b/www/apps/docs/content/references/js-client/classes/internal-35.GiftCard.md deleted file mode 100644 index ac568c380b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.GiftCard.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: GiftCard - -[internal](../modules/internal-35.md).GiftCard - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:120 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.Item.md b/www/apps/docs/content/references/js-client/classes/internal-35.Item.md deleted file mode 100644 index b23974ced1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.Item.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: Item - -[internal](../modules/internal-35.md).Item - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:88 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md b/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md deleted file mode 100644 index aae710b7ea..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: StorePostCartReq - -[internal](../modules/internal-35.md).StorePostCartReq - -## Properties - -### context - -• `Optional` **context**: `object` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:94 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:92 - -___ - -### items - -• `Optional` **items**: [`Item`](internal-35.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:93 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:91 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-cart.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md b/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md deleted file mode 100644 index 7d8d4e52ab..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCartsCartPaymentSessionReq - -[internal](../modules/internal-35.md).StorePostCartsCartPaymentSessionReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/set-payment-session.d.ts:55 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md deleted file mode 100644 index 60fcf4db67..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCartsCartPaymentSessionUpdateReq - -[internal](../modules/internal-35.md).StorePostCartsCartPaymentSessionUpdateReq - -## Properties - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/store/carts/update-payment-session.d.ts:58 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md b/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md deleted file mode 100644 index fdba1ff225..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartReq.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: StorePostCartsCartReq - -[internal](../modules/internal-35.md).StorePostCartsCartReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:129 - -___ - -### context - -• `Optional` **context**: `object` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:134 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:127 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:133 - -___ - -### discounts - -• `Optional` **discounts**: [`Discount`](internal-35.Discount.md)[] - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:132 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:128 - -___ - -### gift\_cards - -• `Optional` **gift\_cards**: [`GiftCard`](internal-35.GiftCard.md)[] - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:131 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:126 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:135 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/store/carts/update-cart.d.ts:130 diff --git a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md b/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md deleted file mode 100644 index ed5240ea40..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-35.StorePostCartsCartShippingMethodReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: StorePostCartsCartShippingMethodReq - -[internal](../modules/internal-35.md).StorePostCartsCartShippingMethodReq - -## Properties - -### data - -• `Optional` **data**: `Record`<`string`, `any`\> - -#### Defined in - -medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:57 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:56 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md deleted file mode 100644 index 62444582d7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md +++ /dev/null @@ -1,49 +0,0 @@ -# Class: StoreGetCustomersCustomerOrdersPaginationParams - -[internal](../modules/internal-37.md).StoreGetCustomersCustomerOrdersPaginationParams - -## Hierarchy - -- **`StoreGetCustomersCustomerOrdersPaginationParams`** - - ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-37.StoreGetCustomersCustomerOrdersParams.md) - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:185 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:184 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:182 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:183 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md deleted file mode 100644 index c2147b4ff5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StoreGetCustomersCustomerOrdersParams.md +++ /dev/null @@ -1,205 +0,0 @@ -# Class: StoreGetCustomersCustomerOrdersParams - -[internal](../modules/internal-37.md).StoreGetCustomersCustomerOrdersParams - -## Hierarchy - -- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md) - - ↳ **`StoreGetCustomersCustomerOrdersParams`** - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:201 - -___ - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:194 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:199 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:197 - -___ - -### display\_id - -• `Optional` **display\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:193 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:195 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:185 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:184 - -___ - -### fulfillment\_status - -• `Optional` **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal.FulfillmentStatus.md)[] - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:191 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:188 - -___ - -### limit - -• **limit**: `number` - -#### Inherited from - -[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:182 - -___ - -### offset - -• **offset**: `number` - -#### Inherited from - -[StoreGetCustomersCustomerOrdersPaginationParams](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:183 - -___ - -### payment\_status - -• `Optional` **payment\_status**: [`PaymentStatus`](../enums/internal.PaymentStatus.md)[] - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:192 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:189 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:196 - -___ - -### status - -• `Optional` **status**: [`OrderStatus`](../enums/internal.OrderStatus.md)[] - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:190 - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:198 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/customers/list-orders.d.ts:200 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md b/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md deleted file mode 100644 index f6f433a3a6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCustomersCustomerPasswordTokenReq - -[internal](../modules/internal-37.md).StorePostCustomersCustomerPasswordTokenReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/reset-password-token.d.ts:62 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md b/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md deleted file mode 100644 index 9272687e74..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersCustomerReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: StorePostCustomersCustomerReq - -[internal](../modules/internal-37.md).StorePostCustomersCustomerReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:91 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:96 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:92 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:93 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:97 - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:94 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/update-customer.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md b/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md deleted file mode 100644 index b6f75ae5d2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: StorePostCustomersReq - -[internal](../modules/internal-37.md).StorePostCustomersReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:106 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:104 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:105 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:107 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/create-customer.d.ts:108 diff --git a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md b/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md deleted file mode 100644 index b874035d51..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-37.StorePostCustomersResetPasswordReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StorePostCustomersResetPasswordReq - -[internal](../modules/internal-37.md).StorePostCustomersResetPasswordReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/reset-password.d.ts:79 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/reset-password.d.ts:81 - -___ - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/api/routes/store/customers/reset-password.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md deleted file mode 100644 index fbf08e2d27..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsItemReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCartsCartLineItemsItemReq - -[internal](../modules/internal-39.md).StorePostCartsCartLineItemsItemReq - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/carts/update-line-item.d.ts:56 diff --git a/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md deleted file mode 100644 index a48c03ccb6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-39.StorePostCartsCartLineItemsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StorePostCartsCartLineItemsReq - -[internal](../modules/internal-39.md).StorePostCartsCartLineItemsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:62 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:61 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:60 diff --git a/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md b/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md index 26a0255b14..4955676dfc 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-4.AdminGetCurrenciesParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetCurrenciesParams [internal](../modules/internal-4.md).AdminGetCurrenciesParams @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:59 +packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:57 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:60 +packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:58 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -54,7 +58,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -64,4 +68,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:61 +packages/medusa/dist/api/routes/admin/currencies/list-currencies.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md b/www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md index 9bf9280aa6..c46cdc1b7b 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-4.AdminPostCurrenciesCurrencyReq.md @@ -1,7 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostCurrenciesCurrencyReq [internal](../modules/internal-4.md).AdminPostCurrenciesCurrencyReq +**`Schema`** + +AdminPostCurrenciesCurrencyReq +type: object +properties: + includes_tax: + type: boolean + x-featureFlag: "tax_inclusive_pricing" + description: "Tax included in prices of currency." + ## Properties ### includes\_tax @@ -10,4 +24,4 @@ #### Defined in -medusa/dist/api/routes/admin/currencies/update-currency.d.ts:58 +packages/medusa/dist/api/routes/admin/currencies/update-currency.d.ts:66 diff --git a/www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md index c088e919be..9152bf8a75 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-4.FindPaginationParams.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: FindPaginationParams [internal](../modules/internal-4.md).FindPaginationParams @@ -8,9 +12,11 @@ ↳ [`AdminGetCurrenciesParams`](internal-4.AdminGetCurrenciesParams.md) - ↳ [`AdminGetProductTypesParams`](internal-19.AdminGetProductTypesParams.md) + ↳ [`AdminGetProductTypesParams`](internal-8.internal.AdminGetProductTypesParams.md) - ↳ [`StoreGetProductTypesParams`](internal-44.StoreGetProductTypesParams.md) + ↳ [`StoreGetProductTagsParams`](internal-8.internal.StoreGetProductTagsParams.md) + + ↳ [`StoreGetProductTypesParams`](internal-8.internal.StoreGetProductTypesParams.md) ## Properties @@ -20,7 +26,7 @@ #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -30,4 +36,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 diff --git a/www/apps/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md b/www/apps/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md deleted file mode 100644 index f7649fe79b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-40.StorePostOrderEditsOrderEditDecline.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostOrderEditsOrderEditDecline - -[internal](../modules/internal-40.md).StorePostOrderEditsOrderEditDecline - -## Properties - -### declined\_reason - -• `Optional` **declined\_reason**: `string` - -#### Defined in - -medusa/dist/api/routes/store/order-edits/decline-order-edit.d.ts:56 diff --git a/www/apps/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md b/www/apps/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md deleted file mode 100644 index e7937b6b8d..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-41.ShippingAddressPayload.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ShippingAddressPayload - -[internal](../modules/internal-41.md).ShippingAddressPayload - -## Properties - -### postal\_code - -• `Optional` **postal\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/store/orders/lookup-order.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md deleted file mode 100644 index 81814b9ff0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-41.StoreGetOrdersParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StoreGetOrdersParams - -[internal](../modules/internal-41.md).StoreGetOrdersParams - -## Properties - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -medusa/dist/api/routes/store/orders/lookup-order.d.ts:74 - -___ - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/store/orders/lookup-order.d.ts:75 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-41.ShippingAddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/store/orders/lookup-order.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md deleted file mode 100644 index 62a173a2da..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCustomersCustomerAcceptClaimReq - -[internal](../modules/internal-41.md).StorePostCustomersCustomerAcceptClaimReq - -## Properties - -### token - -• **token**: `string` - -#### Defined in - -medusa/dist/api/routes/store/orders/confirm-order-request.d.ts:64 diff --git a/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md deleted file mode 100644 index cfb762f641..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostCustomersCustomerOrderClaimReq - -[internal](../modules/internal-41.md).StorePostCustomersCustomerOrderClaimReq - -## Properties - -### order\_ids - -• **order\_ids**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/orders/request-order.d.ts:66 diff --git a/www/apps/docs/content/references/js-client/classes/internal-42.StorePaymentCollectionSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-42.StorePaymentCollectionSessionsReq.md deleted file mode 100644 index be25d9ce68..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-42.StorePaymentCollectionSessionsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePaymentCollectionSessionsReq - -[internal](../modules/internal-42.md).StorePaymentCollectionSessionsReq - -## Properties - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/manage-payment-session.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md b/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md deleted file mode 100644 index 0602b7a2fa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostPaymentCollectionsBatchSessionsAuthorizeReq - -[internal](../modules/internal-42.md).StorePostPaymentCollectionsBatchSessionsAuthorizeReq - -## Properties - -### session\_ids - -• **session\_ids**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/authorize-batch-payment-sessions.d.ts:64 diff --git a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md deleted file mode 100644 index 9ba691ca89..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: StorePostPaymentCollectionsBatchSessionsReq - -[internal](../modules/internal-42.md).StorePostPaymentCollectionsBatchSessionsReq - -## Properties - -### sessions - -• **sessions**: [`StorePostPaymentCollectionsSessionsReq`](internal-42.StorePostPaymentCollectionsSessionsReq.md)[] - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsSessionsReq.md deleted file mode 100644 index 9e78e37cc0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-42.StorePostPaymentCollectionsSessionsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StorePostPaymentCollectionsSessionsReq - -[internal](../modules/internal-42.md).StorePostPaymentCollectionsSessionsReq - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:102 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:101 - -___ - -### session\_id - -• `Optional` **session\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:103 diff --git a/www/apps/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md b/www/apps/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md deleted file mode 100644 index a3c26a5b9e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-45.StoreGetVariantsParams.md +++ /dev/null @@ -1,121 +0,0 @@ -# Class: StoreGetVariantsParams - -[internal](../modules/internal-45.md).StoreGetVariantsParams - -## Hierarchy - -- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) - - ↳ **`StoreGetVariantsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:85 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:87 - -___ - -### ids - -• `Optional` **ids**: `string` - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:86 - -___ - -### inventory\_quantity - -• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-30.NumericalComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:89 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:83 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:84 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 - -___ - -### title - -• `Optional` **title**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/store/variants/list-variants.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md deleted file mode 100644 index c4f4d7341f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsPaginationParams.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: StoreGetProductsPaginationParams - -[internal](../modules/internal-46.md).StoreGetProductsPaginationParams - -## Hierarchy - -- [`PriceSelectionParams`](internal-33.PriceSelectionParams.md) - - ↳ **`StoreGetProductsPaginationParams`** - - ↳↳ [`StoreGetProductsParams`](internal-46.StoreGetProductsParams.md) - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[cart_id](internal-33.PriceSelectionParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[currency_code](internal-33.PriceSelectionParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:170 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:169 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:172 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:171 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[PriceSelectionParams](internal-33.PriceSelectionParams.md).[region_id](internal-33.PriceSelectionParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md deleted file mode 100644 index 28e7cc9f1b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-46.StoreGetProductsParams.md +++ /dev/null @@ -1,227 +0,0 @@ -# Class: StoreGetProductsParams - -[internal](../modules/internal-46.md).StoreGetProductsParams - -## Hierarchy - -- [`StoreGetProductsPaginationParams`](internal-46.StoreGetProductsPaginationParams.md) - - ↳ **`StoreGetProductsParams`** - -## Properties - -### cart\_id - -• `Optional` **cart\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[cart_id](internal-46.StoreGetProductsPaginationParams.md#cart_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:2 - -___ - -### collection\_id - -• `Optional` **collection\_id**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:177 - -___ - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:185 - -___ - -### currency\_code - -• `Optional` **currency\_code**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[currency_code](internal-46.StoreGetProductsPaginationParams.md#currency_code) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:4 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:180 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[expand](internal-46.StoreGetProductsPaginationParams.md#expand) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:170 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[fields](internal-46.StoreGetProductsPaginationParams.md#fields) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:169 - -___ - -### handle - -• `Optional` **handle**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:181 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:175 - -___ - -### is\_giftcard - -• `Optional` **is\_giftcard**: `boolean` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:182 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[limit](internal-46.StoreGetProductsPaginationParams.md#limit) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:172 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[offset](internal-46.StoreGetProductsPaginationParams.md#offset) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:171 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:176 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Inherited from - -[StoreGetProductsPaginationParams](internal-46.StoreGetProductsPaginationParams.md).[region_id](internal-46.StoreGetProductsPaginationParams.md#region_id) - -#### Defined in - -medusa/dist/types/price-selection.d.ts:3 - -___ - -### sales\_channel\_id - -• `Optional` **sales\_channel\_id**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:184 - -___ - -### tags - -• `Optional` **tags**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:178 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:179 - -___ - -### type\_id - -• `Optional` **type\_id**: `string`[] - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:183 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Defined in - -medusa/dist/api/routes/store/products/list-products.d.ts:186 diff --git a/www/apps/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md b/www/apps/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md deleted file mode 100644 index 92f5019117..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-46.StorePostSearchReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: StorePostSearchReq - -[internal](../modules/internal-46.md).StorePostSearchReq - -## Properties - -### filter - -• `Optional` **filter**: `unknown` - -#### Defined in - -medusa/dist/api/routes/store/products/search.d.ts:57 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/store/products/search.d.ts:56 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/store/products/search.d.ts:55 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/store/products/search.d.ts:54 diff --git a/www/apps/docs/content/references/js-client/classes/internal-49.Item.md b/www/apps/docs/content/references/js-client/classes/internal-49.Item.md deleted file mode 100644 index 16e0332cfa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-49.Item.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: Item - -[internal](../modules/internal-49.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:108 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:111 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:109 - -___ - -### reason\_id - -• `Optional` **reason\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:110 diff --git a/www/apps/docs/content/references/js-client/classes/internal-49.ReturnShipping.md b/www/apps/docs/content/references/js-client/classes/internal-49.ReturnShipping.md deleted file mode 100644 index 1a82801225..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-49.ReturnShipping.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: ReturnShipping - -[internal](../modules/internal-49.md).ReturnShipping - -## Properties - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:105 diff --git a/www/apps/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md b/www/apps/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md deleted file mode 100644 index 13ac802fd5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-49.StorePostReturnsReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StorePostReturnsReq - -[internal](../modules/internal-49.md).StorePostReturnsReq - -## Properties - -### items - -• **items**: [`Item`](internal-49.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:115 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:114 - -___ - -### return\_shipping - -• `Optional` **return\_shipping**: [`ReturnShipping`](internal-49.ReturnShipping.md) - -#### Defined in - -medusa/dist/api/routes/store/returns/create-return.d.ts:116 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md deleted file mode 100644 index 9573034c8b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq - -[internal](../modules/internal-5.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq - -## Properties - -### customer\_ids - -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-5.CustomerGroupsBatchCustomer.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md deleted file mode 100644 index 87a046f340..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsGroupParams.md +++ /dev/null @@ -1,37 +0,0 @@ -# Class: AdminGetCustomerGroupsGroupParams - -[internal](../modules/internal-5.md).AdminGetCustomerGroupsGroupParams - -## Hierarchy - -- [`FindParams`](internal-5.FindParams.md) - - ↳ **`AdminGetCustomerGroupsGroupParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) - -#### Defined in - -medusa/dist/types/common.d.ts:117 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Inherited from - -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) - -#### Defined in - -medusa/dist/types/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md deleted file mode 100644 index 3c1be1ef2b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomerGroupsParams.md +++ /dev/null @@ -1,133 +0,0 @@ -# Class: AdminGetCustomerGroupsParams - -[internal](../modules/internal-5.md).AdminGetCustomerGroupsParams - -## Hierarchy - -- [`FilterableCustomerGroupProps`](internal-5.FilterableCustomerGroupProps.md) - - ↳ **`AdminGetCustomerGroupsParams`** - -## Properties - -### created\_at - -• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[created_at](internal-5.FilterableCustomerGroupProps.md#created_at) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:7 - -___ - -### discount\_condition\_id - -• `Optional` **discount\_condition\_id**: `string` - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[discount_condition_id](internal-5.FilterableCustomerGroupProps.md#discount_condition_id) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:8 - -___ - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:159 - -___ - -### id - -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[id](internal-5.FilterableCustomerGroupProps.md#id) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:3 - -___ - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:158 - -___ - -### name - -• `Optional` **name**: `string`[] - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[name](internal-5.FilterableCustomerGroupProps.md#name) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:5 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:157 - -___ - -### order - -• `Optional` **order**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:156 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[q](internal-5.FilterableCustomerGroupProps.md#q) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:4 - -___ - -### updated\_at - -• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) - -#### Inherited from - -[FilterableCustomerGroupProps](internal-5.FilterableCustomerGroupProps.md).[updated_at](internal-5.FilterableCustomerGroupProps.md#updated_at) - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md deleted file mode 100644 index bc73f915c8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminGetCustomersParams.md +++ /dev/null @@ -1,67 +0,0 @@ -# Class: AdminGetCustomersParams - -[internal](../modules/internal-5.md).AdminGetCustomersParams - -## Hierarchy - -- [`AdminListCustomerSelector`](internal-5.AdminListCustomerSelector.md) - - ↳ **`AdminGetCustomersParams`** - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:74 - -___ - -### groups - -• `Optional` **groups**: `string`[] - -#### Inherited from - -[AdminListCustomerSelector](internal-5.AdminListCustomerSelector.md).[groups](internal-5.AdminListCustomerSelector.md#groups) - -#### Defined in - -medusa/dist/types/customers.d.ts:4 - -___ - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:72 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/customers/list-customers.d.ts:73 - -___ - -### q - -• `Optional` **q**: `string` - -#### Inherited from - -[AdminListCustomerSelector](internal-5.AdminListCustomerSelector.md).[q](internal-5.AdminListCustomerSelector.md#q) - -#### Defined in - -medusa/dist/types/customers.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md deleted file mode 100644 index 0a72eaa785..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminListCustomerSelector.md +++ /dev/null @@ -1,29 +0,0 @@ -# Class: AdminListCustomerSelector - -[internal](../modules/internal-5.md).AdminListCustomerSelector - -## Hierarchy - -- **`AdminListCustomerSelector`** - - ↳ [`AdminGetCustomersParams`](internal-5.AdminGetCustomersParams.md) - -## Properties - -### groups - -• `Optional` **groups**: `string`[] - -#### Defined in - -medusa/dist/types/customers.d.ts:4 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/types/customers.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md deleted file mode 100644 index 7aec2f0c6e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostCustomerGroupsGroupCustomersBatchReq - -[internal](../modules/internal-5.md).AdminPostCustomerGroupsGroupCustomersBatchReq - -## Properties - -### customer\_ids - -• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-5.CustomerGroupsBatchCustomer.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md deleted file mode 100644 index b4c3c482b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsGroupReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostCustomerGroupsGroupReq - -[internal](../modules/internal-5.md).AdminPostCustomerGroupsGroupReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:76 - -___ - -### name - -• `Optional` **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md b/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md deleted file mode 100644 index 6058072336..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.AdminPostCustomerGroupsReq.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminPostCustomerGroupsReq - -[internal](../modules/internal-5.md).AdminPostCustomerGroupsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:65 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:64 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md b/www/apps/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md deleted file mode 100644 index c8d064638e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.CustomerGroupsBatchCustomer.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: CustomerGroupsBatchCustomer - -[internal](../modules/internal-5.md).CustomerGroupsBatchCustomer - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/types/customer-groups.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.FindParams.md b/www/apps/docs/content/references/js-client/classes/internal-5.FindParams.md deleted file mode 100644 index 302af1e8f4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.FindParams.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: FindParams - -[internal](../modules/internal-5.md).FindParams - -## Hierarchy - -- **`FindParams`** - - ↳ [`AdminGetCustomerGroupsGroupParams`](internal-5.AdminGetCustomerGroupsGroupParams.md) - - ↳ [`AdminPostDiscountsDiscountConditionsParams`](internal-7.AdminPostDiscountsDiscountConditionsParams.md) - - ↳ [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) - - ↳ [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) - - ↳ [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) - - ↳ [`GetOrderEditsOrderEditParams`](internal-13.GetOrderEditsOrderEditParams.md) - - ↳ [`GetPaymentCollectionsParams`](internal-15.GetPaymentCollectionsParams.md) - - ↳ [`GetPaymentsParams`](internal-16.GetPaymentsParams.md) - -## Properties - -### expand - -• `Optional` **expand**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:117 - -___ - -### fields - -• `Optional` **fields**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md deleted file mode 100644 index e8cb2cc19f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-5.StringComparisonOperator.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: StringComparisonOperator - -[internal](../modules/internal-5.md).StringComparisonOperator - -## Properties - -### gt - -• `Optional` **gt**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:80 - -___ - -### gte - -• `Optional` **gte**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:81 - -___ - -### lt - -• `Optional` **lt**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:79 - -___ - -### lte - -• `Optional` **lte**: `string` - -#### Defined in - -medusa/dist/types/common.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md deleted file mode 100644 index fcb9cd6733..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-50.StoreGetShippingOptionsParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: StoreGetShippingOptionsParams - -[internal](../modules/internal-50.md).StoreGetShippingOptionsParams - -## Properties - -### is\_return - -• `Optional` **is\_return**: `string` - -#### Defined in - -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:54 - -___ - -### product\_ids - -• `Optional` **product\_ids**: `string` - -#### Defined in - -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:52 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/shipping-options/list-options.d.ts:53 diff --git a/www/apps/docs/content/references/js-client/classes/internal-51.AdditionalItem.md b/www/apps/docs/content/references/js-client/classes/internal-51.AdditionalItem.md deleted file mode 100644 index 89aac74acc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-51.AdditionalItem.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdditionalItem - -[internal](../modules/internal-51.md).AdditionalItem - -## Properties - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:133 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:132 diff --git a/www/apps/docs/content/references/js-client/classes/internal-51.Item.md b/www/apps/docs/content/references/js-client/classes/internal-51.Item.md deleted file mode 100644 index 300b2566cf..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-51.Item.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: Item - -[internal](../modules/internal-51.md).Item - -## Properties - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:126 - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:129 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:127 - -___ - -### reason\_id - -• `Optional` **reason\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:128 diff --git a/www/apps/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md b/www/apps/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md deleted file mode 100644 index 0a42548cfd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-51.StorePostSwapsReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: StorePostSwapsReq - -[internal](../modules/internal-51.md).StorePostSwapsReq - -## Properties - -### additional\_items - -• **additional\_items**: [`AdditionalItem`](internal-51.AdditionalItem.md)[] - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:138 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:136 - -___ - -### return\_items - -• **return\_items**: [`Item`](internal-51.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:137 - -___ - -### return\_shipping\_option - -• `Optional` **return\_shipping\_option**: `string` - -#### Defined in - -medusa/dist/api/routes/store/swaps/create-swap.d.ts:139 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md new file mode 100644 index 0000000000..88f507f91e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq + +[internal](../modules/internal-6.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq + +**`Schema`** + +AdminDeleteCustomerGroupsGroupCustomerBatchReq +type: object +required: + - customer_ids +properties: + customer_ids: + description: "The ids of the customers to remove" + type: array + items: + type: object + required: + - id + properties: + id: + description: ID of the customer + type: string + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-6.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md new file mode 100644 index 0000000000..38aa3b84c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsGroupParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomerGroupsGroupParams + +[internal](../modules/internal-6.md).AdminGetCustomerGroupsGroupParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetCustomerGroupsGroupParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md new file mode 100644 index 0000000000..6d2a276e8c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminGetCustomerGroupsParams.md @@ -0,0 +1,137 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomerGroupsParams + +[internal](../modules/internal-6.md).AdminGetCustomerGroupsParams + +## Hierarchy + +- [`FilterableCustomerGroupProps`](internal-6.FilterableCustomerGroupProps.md) + + ↳ **`AdminGetCustomerGroupsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[created_at](internal-6.FilterableCustomerGroupProps.md#created_at) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:7 + +___ + +### discount\_condition\_id + +• `Optional` **discount\_condition\_id**: `string` + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[discount_condition_id](internal-6.FilterableCustomerGroupProps.md#discount_condition_id) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:8 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:149 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[id](internal-6.FilterableCustomerGroupProps.md#id) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:3 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:148 + +___ + +### name + +• `Optional` **name**: `string`[] + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[name](internal-6.FilterableCustomerGroupProps.md#name) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:5 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:147 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:146 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[q](internal-6.FilterableCustomerGroupProps.md#q) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:4 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableCustomerGroupProps](internal-6.FilterableCustomerGroupProps.md).[updated_at](internal-6.FilterableCustomerGroupProps.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md new file mode 100644 index 0000000000..512f478a88 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsGroupCustomersBatchReq + +[internal](../modules/internal-6.md).AdminPostCustomerGroupsGroupCustomersBatchReq + +**`Schema`** + +AdminPostCustomerGroupsGroupCustomersBatchReq +type: object +required: + - customer_ids +properties: + customer_ids: + description: "The ids of the customers to add" + type: array + items: + type: object + required: + - id + properties: + id: + description: ID of the customer + type: string + +## Properties + +### customer\_ids + +• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal-6.CustomerGroupsBatchCustomer.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md new file mode 100644 index 0000000000..6ff9148062 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsGroupReq.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsGroupReq + +[internal](../modules/internal-6.md).AdminPostCustomerGroupsGroupReq + +**`Schema`** + +AdminPostCustomerGroupsGroupReq +type: object +properties: + name: + description: "Name of the customer group" + type: string + metadata: + description: "Metadata of the customer group." + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:83 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsReq.md new file mode 100644 index 0000000000..913bbfdc70 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomerGroupsReq.md @@ -0,0 +1,44 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomerGroupsReq + +[internal](../modules/internal-6.md).AdminPostCustomerGroupsReq + +**`Schema`** + +AdminPostCustomerGroupsReq +type: object +required: + - name +properties: + name: + type: string + description: Name of the customer group + metadata: + type: object + description: Metadata of the customer group. + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:83 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md deleted file mode 100644 index b6aafa8b9a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersCustomerReq.md +++ /dev/null @@ -1,73 +0,0 @@ -# Class: AdminPostCustomersCustomerReq - -[internal](../modules/internal-6.md).AdminPostCustomersCustomerReq - -## Properties - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:103 - -___ - -### first\_name - -• `Optional` **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:104 - -___ - -### groups - -• `Optional` **groups**: [`Group`](internal-6.Group.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:109 - -___ - -### last\_name - -• `Optional` **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:105 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:108 - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:106 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:107 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md b/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md deleted file mode 100644 index c39db02ee7..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.AdminPostCustomersReq.md +++ /dev/null @@ -1,63 +0,0 @@ -# Class: AdminPostCustomersReq - -[internal](../modules/internal-6.md).AdminPostCustomersReq - -## Properties - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:97 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:98 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:99 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:102 - -___ - -### password - -• **password**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:100 - -___ - -### phone - -• `Optional` **phone**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/create-customer.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md b/www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md new file mode 100644 index 0000000000..9d414f199d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.CustomerGroupsBatchCustomer.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroupsBatchCustomer + +[internal](../modules/internal-6.md).CustomerGroupsBatchCustomer + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md b/www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md similarity index 58% rename from www/apps/docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md rename to www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md index a51bb611fa..efb19f9243 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-5.FilterableCustomerGroupProps.md +++ b/www/apps/docs/content/references/js-client/classes/internal-6.FilterableCustomerGroupProps.md @@ -1,12 +1,16 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: FilterableCustomerGroupProps -[internal](../modules/internal-5.md).FilterableCustomerGroupProps +[internal](../modules/internal-6.md).FilterableCustomerGroupProps ## Hierarchy - **`FilterableCustomerGroupProps`** - ↳ [`AdminGetCustomerGroupsParams`](internal-5.AdminGetCustomerGroupsParams.md) + ↳ [`AdminGetCustomerGroupsParams`](internal-6.AdminGetCustomerGroupsParams.md) ## Properties @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/types/customer-groups.d.ts:7 +packages/medusa/dist/types/customer-groups.d.ts:7 ___ @@ -26,17 +30,17 @@ ___ #### Defined in -medusa/dist/types/customer-groups.d.ts:8 +packages/medusa/dist/types/customer-groups.d.ts:8 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) #### Defined in -medusa/dist/types/customer-groups.d.ts:3 +packages/medusa/dist/types/customer-groups.d.ts:3 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/types/customer-groups.d.ts:5 +packages/medusa/dist/types/customer-groups.d.ts:5 ___ @@ -56,7 +60,7 @@ ___ #### Defined in -medusa/dist/types/customer-groups.d.ts:4 +packages/medusa/dist/types/customer-groups.d.ts:4 ___ @@ -66,4 +70,4 @@ ___ #### Defined in -medusa/dist/types/customer-groups.d.ts:6 +packages/medusa/dist/types/customer-groups.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.FindParams.md b/www/apps/docs/content/references/js-client/classes/internal-6.FindParams.md new file mode 100644 index 0000000000..1469979a49 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.FindParams.md @@ -0,0 +1,145 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FindParams + +[internal](../modules/internal-6.md).FindParams + +## Hierarchy + +- **`FindParams`** + + ↳ [`AdminGetCustomerGroupsGroupParams`](internal-6.AdminGetCustomerGroupsGroupParams.md) + + ↳ [`AdminPostDiscountsDiscountConditionsParams`](internal-8.AdminPostDiscountsDiscountConditionsParams.md) + + ↳ [`AdminPostDiscountsDiscountConditionsConditionParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) + + ↳ [`AdminGetDiscountsDiscountConditionsConditionParams`](internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) + + ↳ [`AdminPostDiscountsDiscountConditionsConditionBatchParams`](internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) + + ↳ [`AdminPostDiscountsParams`](internal-8.internal.AdminPostDiscountsParams.md) + + ↳ [`AdminDeleteDiscountsDiscountConditionsConditionParams`](internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md) + + ↳ [`AdminGetDiscountParams`](internal-8.internal.AdminGetDiscountParams.md) + + ↳ [`AdminGetDiscountsDiscountCodeParams`](internal-8.internal.AdminGetDiscountsDiscountCodeParams.md) + + ↳ [`AdminPostDiscountsDiscountParams`](internal-8.internal.AdminPostDiscountsDiscountParams.md) + + ↳ [`AdminDeleteDiscountsDiscountConditionsConditionBatchParams`](internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md) + + ↳ [`AdminPostInventoryItemsParams`](internal-8.internal.AdminPostInventoryItemsParams.md) + + ↳ [`AdminPostInventoryItemsItemLocationLevelsParams`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md) + + ↳ [`AdminGetInventoryItemsItemParams`](internal-8.internal.AdminGetInventoryItemsItemParams.md) + + ↳ [`AdminGetInventoryItemsItemLocationLevelsParams`](internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md) + + ↳ [`AdminPostInventoryItemsInventoryItemParams`](internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md) + + ↳ [`AdminPostInventoryItemsItemLocationLevelsLevelParams`](internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md) + + ↳ [`GetOrderEditsOrderEditParams`](internal-8.internal.GetOrderEditsOrderEditParams.md) + + ↳ [`AdminPostOrdersOrderShippingMethodsParams`](internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md) + + ↳ [`AdminPostOrdersOrderArchiveParams`](internal-8.internal.AdminPostOrdersOrderArchiveParams.md) + + ↳ [`AdminPostOrdersClaimCancel`](internal-8.internal.AdminPostOrdersClaimCancel.md) + + ↳ [`AdminPostOrdersOrderFulfillementsCancelParams`](internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md) + + ↳ [`AdminPostOrdersClaimFulfillmentsCancelParams`](internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md) + + ↳ [`AdminPostOrdersOrderSwapFulfillementsCancelParams`](internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md) + + ↳ [`AdminPostOrdersOrderCancel`](internal-8.internal.AdminPostOrdersOrderCancel.md) + + ↳ [`AdminPostOrdersSwapCancelParams`](internal-8.internal.AdminPostOrdersSwapCancelParams.md) + + ↳ [`AdminPostOrdersOrderCaptureParams`](internal-8.internal.AdminPostOrdersOrderCaptureParams.md) + + ↳ [`AdminPostOrdersOrderCompleteParams`](internal-8.internal.AdminPostOrdersOrderCompleteParams.md) + + ↳ [`AdminPostOrdersOrderClaimsParams`](internal-8.internal.AdminPostOrdersOrderClaimsParams.md) + + ↳ [`AdminPostOrdersOrderClaimsClaimShipmentsParams`](internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md) + + ↳ [`AdminPostOrdersOrderFulfillmentsParams`](internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md) + + ↳ [`AdminPostOrdersOrderShipmentParams`](internal-8.internal.AdminPostOrdersOrderShipmentParams.md) + + ↳ [`AdminPostOrdersOrderSwapsParams`](internal-8.internal.AdminPostOrdersOrderSwapsParams.md) + + ↳ [`AdminPostOrdersOrderSwapsSwapShipmentsParams`](internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md) + + ↳ [`AdminPostOrdersOrderClaimsClaimFulfillmentsParams`](internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md) + + ↳ [`AdminPostOrdersOrderSwapsSwapFulfillmentsParams`](internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md) + + ↳ [`AdminGetOrdersOrderParams`](internal-8.internal.AdminGetOrdersOrderParams.md) + + ↳ [`AdminPostOrdersOrderSwapsSwapProcessPaymentParams`](internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md) + + ↳ [`AdminPostOrdersOrderRefundsParams`](internal-8.internal.AdminPostOrdersOrderRefundsParams.md) + + ↳ [`AdminPostOrdersOrderReturnsParams`](internal-8.internal.AdminPostOrdersOrderReturnsParams.md) + + ↳ [`AdminPostOrdersOrderClaimsClaimParams`](internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md) + + ↳ [`AdminPostOrdersOrderParams`](internal-8.internal.AdminPostOrdersOrderParams.md) + + ↳ [`AdminGetPaymentCollectionsParams`](internal-8.internal.AdminGetPaymentCollectionsParams.md) + + ↳ [`GetPaymentsParams`](internal-8.internal.GetPaymentsParams.md) + + ↳ [`AdminGetProductCategoryParams`](internal-8.internal.AdminGetProductCategoryParams.md) + + ↳ [`AdminPostProductCategoriesParams`](internal-8.internal.AdminPostProductCategoriesParams.md) + + ↳ [`AdminPostProductCategoriesCategoryParams`](internal-8.internal.AdminPostProductCategoriesCategoryParams.md) + + ↳ [`AdminPostProductCategoriesCategoryProductsBatchParams`](internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md) + + ↳ [`AdminDeleteProductCategoriesCategoryProductsBatchParams`](internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md) + + ↳ [`AdminPostStockLocationsParams`](internal-8.internal.AdminPostStockLocationsParams.md) + + ↳ [`AdminGetStockLocationsLocationParams`](internal-8.internal.AdminGetStockLocationsLocationParams.md) + + ↳ [`AdminPostStockLocationsLocationParams`](internal-8.internal.AdminPostStockLocationsLocationParams.md) + + ↳ [`AdminGetVariantParams`](internal-8.internal.AdminGetVariantParams.md) + + ↳ [`StoreGetOrdersParams`](internal-8.internal.StoreGetOrdersParams.md) + + ↳ [`StoreGetPaymentCollectionsParams`](internal-8.internal.StoreGetPaymentCollectionsParams.md) + + ↳ [`StoreGetProductCategoriesCategoryParams`](internal-8.internal.StoreGetProductCategoriesCategoryParams.md) + + ↳ [`PriceSelectionParams`](internal-8.PriceSelectionParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.Group.md b/www/apps/docs/content/references/js-client/classes/internal-6.Group.md deleted file mode 100644 index b9bbd4050b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-6.Group.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: Group - -[internal](../modules/internal-6.md).Group - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/customers/update-customer.d.ts:100 diff --git a/www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md new file mode 100644 index 0000000000..7427b2d689 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-6.StringComparisonOperator.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StringComparisonOperator + +[internal](../modules/internal-6.md).StringComparisonOperator + +## Properties + +### contains + +• `Optional` **contains**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:93 + +___ + +### ends\_with + +• `Optional` **ends\_with**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:95 + +___ + +### gt + +• `Optional` **gt**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:90 + +___ + +### gte + +• `Optional` **gte**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:91 + +___ + +### lt + +• `Optional` **lt**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:89 + +___ + +### lte + +• `Optional` **lte**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:92 + +___ + +### starts\_with + +• `Optional` **starts\_with**: `string` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md deleted file mode 100644 index 7a5c2125ef..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminCreateCondition.md +++ /dev/null @@ -1,89 +0,0 @@ -# Class: AdminCreateCondition - -[internal](../modules/internal-7.md).AdminCreateCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) - - ↳ **`AdminCreateCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -medusa/dist/types/discount.d.ts:20 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:204 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -medusa/dist/types/discount.d.ts:17 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -medusa/dist/types/discount.d.ts:19 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -medusa/dist/types/discount.d.ts:18 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) - -#### Defined in - -medusa/dist/types/discount.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md deleted file mode 100644 index 1de61ec332..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminDeleteDiscountsDiscountConditionsConditionBatchReq - -[internal](../modules/internal-7.md).AdminDeleteDiscountsDiscountConditionsConditionBatchReq - -## Properties - -### resources - -• **resources**: { `id`: `string` }[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/delete-resources-from-condition-batch.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md new file mode 100644 index 0000000000..e949aaee8d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetCustomersParams.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetCustomersParams + +[internal](../modules/internal-7.md).AdminGetCustomersParams + +## Hierarchy + +- [`AdminListCustomerSelector`](internal-7.AdminListCustomerSelector.md) + + ↳ **`AdminGetCustomersParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:72 + +___ + +### groups + +• `Optional` **groups**: `string`[] + +#### Inherited from + +[AdminListCustomerSelector](internal-7.AdminListCustomerSelector.md).[groups](internal-7.AdminListCustomerSelector.md#groups) + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:5 + +___ + +### has\_account + +• `Optional` **has\_account**: `boolean` + +#### Inherited from + +[AdminListCustomerSelector](internal-7.AdminListCustomerSelector.md).[has_account](internal-7.AdminListCustomerSelector.md#has_account) + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:4 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:70 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:71 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListCustomerSelector](internal-7.AdminListCustomerSelector.md).[q](internal-7.AdminListCustomerSelector.md#q) + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md deleted file mode 100644 index 41cab839e4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountRuleParams.md +++ /dev/null @@ -1,23 +0,0 @@ -# Class: AdminGetDiscountsDiscountRuleParams - -[internal](../modules/internal-7.md).AdminGetDiscountsDiscountRuleParams - -## Properties - -### allocation - -• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) - -#### Defined in - -medusa/dist/types/discount.d.ts:13 - -___ - -### type - -• `Optional` **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md) - -#### Defined in - -medusa/dist/types/discount.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md new file mode 100644 index 0000000000..2c734e277a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-7.AdminListCustomerSelector.md @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminListCustomerSelector + +[internal](../modules/internal-7.md).AdminListCustomerSelector + +## Hierarchy + +- **`AdminListCustomerSelector`** + + ↳ [`AdminGetCustomersParams`](internal-7.AdminGetCustomersParams.md) + +## Properties + +### groups + +• `Optional` **groups**: `string`[] + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:5 + +___ + +### has\_account + +• `Optional` **has\_account**: `boolean` + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:4 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md new file mode 100644 index 0000000000..7b511d9b1d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersCustomerReq.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomersCustomerReq + +[internal](../modules/internal-7.md).AdminPostCustomersCustomerReq + +**`Schema`** + +AdminPostCustomersCustomerReq +type: object +properties: + email: + type: string + description: The Customer's email. You can't update the email of a registered customer. + format: email + first_name: + type: string + description: The Customer's first name. + last_name: + type: string + description: The Customer's last name. + phone: + type: string + description: The Customer's phone number. + password: + type: string + description: The Customer's password. + format: password + groups: + type: array + description: A list of customer groups to which the customer belongs. + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:111 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:112 + +___ + +### groups + +• `Optional` **groups**: [`Group`](internal-7.Group.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:117 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:113 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:116 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:114 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:115 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersReq.md new file mode 100644 index 0000000000..ff6b6d55cd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostCustomersReq.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostCustomersReq + +[internal](../modules/internal-7.md).AdminPostCustomersReq + +**`Schema`** + +AdminPostCustomersReq +type: object +required: + - email + - first_name + - last_name + - password +properties: + email: + type: string + description: The customer's email. + format: email + first_name: + type: string + description: The customer's first name. + last_name: + type: string + description: The customer's last name. + password: + type: string + description: The customer's password. + format: password + phone: + type: string + description: The customer's phone number. + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:104 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:105 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:106 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:109 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:107 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:108 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md deleted file mode 100644 index c8757572d6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditions.md +++ /dev/null @@ -1,89 +0,0 @@ -# Class: AdminPostDiscountsDiscountConditions - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditions - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) - - ↳ **`AdminPostDiscountsDiscountConditions`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -medusa/dist/types/discount.d.ts:20 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-condition.d.ts:106 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -medusa/dist/types/discount.d.ts:17 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -medusa/dist/types/discount.d.ts:19 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -medusa/dist/types/discount.d.ts:18 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) - -#### Defined in - -medusa/dist/types/discount.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md deleted file mode 100644 index 58d4998839..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md +++ /dev/null @@ -1,79 +0,0 @@ -# Class: AdminPostDiscountsDiscountConditionsCondition - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) - - ↳ **`AdminPostDiscountsDiscountConditionsCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -medusa/dist/types/discount.d.ts:20 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -medusa/dist/types/discount.d.ts:17 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -medusa/dist/types/discount.d.ts:19 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -medusa/dist/types/discount.d.ts:18 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) - -#### Defined in - -medusa/dist/types/discount.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md deleted file mode 100644 index 938c2f51ff..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md +++ /dev/null @@ -1,13 +0,0 @@ -# Class: AdminPostDiscountsDiscountConditionsConditionBatchReq - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsConditionBatchReq - -## Properties - -### resources - -• **resources**: { `id`: `string` }[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/add-resources-to-condition-batch.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md deleted file mode 100644 index c315ed0458..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminPostDiscountsDiscountDynamicCodesReq - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountDynamicCodesReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:67 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:69 - -___ - -### usage\_limit - -• **usage\_limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:68 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md deleted file mode 100644 index ff280b06a5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountReq.md +++ /dev/null @@ -1,93 +0,0 @@ -# Class: AdminPostDiscountsDiscountReq - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountReq - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:162 - -___ - -### ends\_at - -• `Optional` **ends\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:166 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:164 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:170 - -___ - -### regions - -• `Optional` **regions**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:169 - -___ - -### rule - -• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal-7.AdminUpdateDiscountRule.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:163 - -___ - -### starts\_at - -• `Optional` **starts\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:165 - -___ - -### usage\_limit - -• `Optional` **usage\_limit**: ``null`` \| `number` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:168 - -___ - -### valid\_duration - -• `Optional` **valid\_duration**: ``null`` \| `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:167 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md deleted file mode 100644 index 722c87eba5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountRule.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminPostDiscountsDiscountRule - -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountRule - -## Properties - -### allocation - -• **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:200 - -___ - -### conditions - -• `Optional` **conditions**: [`AdminCreateCondition`](internal-7.AdminCreateCondition.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:201 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:197 - -___ - -### type - -• **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:198 - -___ - -### value - -• **value**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:199 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md deleted file mode 100644 index 014982154f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsReq.md +++ /dev/null @@ -1,103 +0,0 @@ -# Class: AdminPostDiscountsReq - -[internal](../modules/internal-7.md).AdminPostDiscountsReq - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:185 - -___ - -### ends\_at - -• `Optional` **ends\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:190 - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:188 - -___ - -### is\_dynamic - -• **is\_dynamic**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:187 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:194 - -___ - -### regions - -• **regions**: `string`[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:193 - -___ - -### rule - -• **rule**: [`AdminPostDiscountsDiscountRule`](internal-7.AdminPostDiscountsDiscountRule.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:186 - -___ - -### starts\_at - -• `Optional` **starts\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:189 - -___ - -### usage\_limit - -• `Optional` **usage\_limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:192 - -___ - -### valid\_duration - -• `Optional` **valid\_duration**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/create-discount.d.ts:191 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md deleted file mode 100644 index 2919ecffe1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpdateDiscountRule.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminUpdateDiscountRule - -[internal](../modules/internal-7.md).AdminUpdateDiscountRule - -## Properties - -### allocation - -• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:176 - -___ - -### conditions - -• `Optional` **conditions**: [`AdminUpsertCondition`](internal-7.AdminUpsertCondition.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:177 - -___ - -### description - -• `Optional` **description**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:174 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:173 - -___ - -### value - -• `Optional` **value**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:175 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md b/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md deleted file mode 100644 index 1e1f946dae..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertCondition.md +++ /dev/null @@ -1,99 +0,0 @@ -# Class: AdminUpsertCondition - -[internal](../modules/internal-7.md).AdminUpsertCondition - -## Hierarchy - -- [`AdminUpsertConditionsReq`](internal-7.AdminUpsertConditionsReq.md) - - ↳ **`AdminUpsertCondition`** - -## Properties - -### customer\_groups - -• `Optional` **customer\_groups**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[customer_groups](internal-7.AdminUpsertConditionsReq.md#customer_groups) - -#### Defined in - -medusa/dist/types/discount.d.ts:20 - -___ - -### id - -• `Optional` **id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:180 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/update-discount.d.ts:181 - -___ - -### product\_collections - -• `Optional` **product\_collections**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_collections](internal-7.AdminUpsertConditionsReq.md#product_collections) - -#### Defined in - -medusa/dist/types/discount.d.ts:17 - -___ - -### product\_tags - -• `Optional` **product\_tags**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_tags](internal-7.AdminUpsertConditionsReq.md#product_tags) - -#### Defined in - -medusa/dist/types/discount.d.ts:19 - -___ - -### product\_types - -• `Optional` **product\_types**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[product_types](internal-7.AdminUpsertConditionsReq.md#product_types) - -#### Defined in - -medusa/dist/types/discount.d.ts:18 - -___ - -### products - -• `Optional` **products**: `string`[] - -#### Inherited from - -[AdminUpsertConditionsReq](internal-7.AdminUpsertConditionsReq.md).[products](internal-7.AdminUpsertConditionsReq.md#products) - -#### Defined in - -medusa/dist/types/discount.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.Group.md b/www/apps/docs/content/references/js-client/classes/internal-7.Group.md new file mode 100644 index 0000000000..5e834d154a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-7.Group.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Group + +[internal](../modules/internal-7.md).Group + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md b/www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md new file mode 100644 index 0000000000..16f0b6ba94 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AbstractEventBusModuleService.md @@ -0,0 +1,168 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractEventBusModuleService + +[internal](../modules/internal-8.md).AbstractEventBusModuleService + +## Implements + +- [`IEventBusModuleService`](../interfaces/internal-8.IEventBusModuleService.md) + +## Properties + +### eventToSubscribersMap\_ + +• `Protected` **eventToSubscribersMap\_**: `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../modules/internal-8.md#subscriberdescriptor)[]\> + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:3 + +## Accessors + +### eventToSubscribersMap + +• `get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../modules/internal-8.md#subscriberdescriptor)[]\> + +#### Returns + +`Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../modules/internal-8.md#subscriberdescriptor)[]\> + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:4 + +## Methods + +### emit + +▸ `Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` | +| `data` | `T` | +| `options` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md).[emit](../interfaces/internal-8.IEventBusModuleService.md#emit) + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:5 + +▸ `Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`EmitData`](../modules/internal-8.md#emitdata)<`T`\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md).[emit](../interfaces/internal-8.IEventBusModuleService.md#emit) + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:6 + +___ + +### storeSubscribers + +▸ `Protected` **storeSubscribers**(`«destructured»`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `event` | `string` \| `symbol` | +| › `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber)<`unknown`\> | +| › `subscriberId` | `string` | + +#### Returns + +`void` + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:7 + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`AbstractEventBusModuleService`](internal-8.AbstractEventBusModuleService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber)<`unknown`\> | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`AbstractEventBusModuleService`](internal-8.AbstractEventBusModuleService.md) + +#### Implementation of + +[IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md).[subscribe](../interfaces/internal-8.IEventBusModuleService.md#subscribe) + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:12 + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context`): [`AbstractEventBusModuleService`](internal-8.AbstractEventBusModuleService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber)<`unknown`\> | +| `context` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`AbstractEventBusModuleService`](internal-8.AbstractEventBusModuleService.md) + +#### Implementation of + +[IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md).[unsubscribe](../interfaces/internal-8.IEventBusModuleService.md#unsubscribe) + +#### Defined in + +packages/utils/dist/event-bus/index.d.ts:13 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md b/www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md new file mode 100644 index 0000000000..70da797654 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md @@ -0,0 +1,288 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractSearchService + +[internal](../modules/internal-8.md).AbstractSearchService + +## Hierarchy + +- **`AbstractSearchService`** + + ↳ [`SearchService`](internal-8.internal.SearchService.md) + +## Implements + +- [`ISearchService`](../interfaces/internal-8.ISearchService.md) + +## Properties + +### isDefault + +• `Readonly` `Abstract` **isDefault**: `any` + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:3 + +___ + +### options\_ + +• `Protected` `Readonly` **options\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:4 + +## Accessors + +### options + +• `get` **options**(): [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Returns + +[`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[options](../interfaces/internal-8.ISearchService.md#options) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:5 + +## Methods + +### addDocuments + +▸ `Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to index documents by the search engine provider + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `documents` | `unknown` | documents array to be indexed | +| `type` | `string` | of documents to be added (e.g: products, regions, orders, etc) | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[addDocuments](../interfaces/internal-8.ISearchService.md#adddocuments) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:9 + +___ + +### createIndex + +▸ `Abstract` **createIndex**(`indexName`, `options`): `unknown` + +Used to create an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `options` | `unknown` | the options | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[createIndex](../interfaces/internal-8.ISearchService.md#createindex) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:7 + +___ + +### deleteAllDocuments + +▸ `Abstract` **deleteAllDocuments**(`indexName`): `unknown` + +Used to delete all documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[deleteAllDocuments](../interfaces/internal-8.ISearchService.md#deletealldocuments) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:12 + +___ + +### deleteDocument + +▸ `Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown` + +Used to delete document + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `document_id` | `string` \| `number` | the id of the document | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[deleteDocument](../interfaces/internal-8.ISearchService.md#deletedocument) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:11 + +___ + +### getIndex + +▸ `Abstract` **getIndex**(`indexName`): `unknown` + +Used to get an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[getIndex](../interfaces/internal-8.ISearchService.md#getindex) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:8 + +___ + +### replaceDocuments + +▸ `Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to replace documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | +| `documents` | `unknown` | array of document objects that will replace existing documents | +| `type` | `string` | type of documents to be replaced (e.g: products, regions, orders, etc) | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[replaceDocuments](../interfaces/internal-8.ISearchService.md#replacedocuments) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:10 + +___ + +### search + +▸ `Abstract` **search**(`indexName`, `query`, `options`): `unknown` + +Used to search for a document in an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `query` | ``null`` \| `string` | the search query | +| `options` | `unknown` | any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[search](../interfaces/internal-8.ISearchService.md#search) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:13 + +___ + +### updateSettings + +▸ `Abstract` **updateSettings**(`indexName`, `settings`): `unknown` + +Used to update the settings of an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `settings` | `unknown` | settings object | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Implementation of + +[ISearchService](../interfaces/internal-8.ISearchService.md).[updateSettings](../interfaces/internal-8.ISearchService.md#updatesettings) + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md new file mode 100644 index 0000000000..fef3f92204 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-1.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdditionalItem + +[internal](../modules/internal-8.md).AdditionalItem + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:186 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:185 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md new file mode 100644 index 0000000000..d15e4c174c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem-2.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdditionalItem + +[internal](../modules/internal-8.md).AdditionalItem + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:96 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md new file mode 100644 index 0000000000..89ff18af9d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdditionalItem.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdditionalItem + +[internal](../modules/internal-8.md).AdditionalItem + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:227 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:226 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md new file mode 100644 index 0000000000..cf85f1030a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminCreateCondition.md @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminCreateCondition + +[internal](../modules/internal-8.md).AdminCreateCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-8.AdminUpsertConditionsReq.md) + + ↳ **`AdminCreateCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[customer_groups](internal-8.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:213 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_collections](internal-8.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_tags](internal-8.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_types](internal-8.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[products](internal-8.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md new file mode 100644 index 0000000000..9ad1e335cf --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteDiscountsDiscountConditionsConditionBatchReq + +[internal](../modules/internal-8.md).AdminDeleteDiscountsDiscountConditionsConditionBatchReq + +**`Schema`** + +AdminDeleteDiscountsDiscountConditionsConditionBatchReq +type: object +required: + - resources +properties: + resources: + description: The resources to be removed from the discount condition + type: array + items: + type: object + required: + - id + properties: + id: + description: The id of the item + type: string + +## Properties + +### resources + +• **resources**: { `id`: `string` }[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/delete-resources-from-condition-batch.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md similarity index 52% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md index 0fb28a93b1..1a86c409e9 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetDiscountsDiscountConditionsConditionParams -[internal](../modules/internal-7.md).AdminGetDiscountsDiscountConditionsConditionParams +[internal](../modules/internal-8.md).AdminGetDiscountsDiscountConditionsConditionParams ## Hierarchy -- [`FindParams`](internal-5.FindParams.md) +- [`FindParams`](internal-6.FindParams.md) ↳ **`AdminGetDiscountsDiscountConditionsConditionParams`** @@ -16,11 +20,11 @@ #### Inherited from -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -30,8 +34,8 @@ ___ #### Inherited from -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md new file mode 100644 index 0000000000..2d21ebf711 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsDiscountRuleParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountsDiscountRuleParams + +[internal](../modules/internal-8.md).AdminGetDiscountsDiscountRuleParams + +## Properties + +### allocation + +• `Optional` **allocation**: [`AllocationType`](../enums/internal-3.AllocationType.md) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:14 + +___ + +### type + +• `Optional` **type**: [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:13 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md similarity index 58% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md index 79579ffaca..2d091b194c 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminGetDiscountsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDiscountsParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetDiscountsParams -[internal](../modules/internal-7.md).AdminGetDiscountsParams +[internal](../modules/internal-8.md).AdminGetDiscountsParams ## Hierarchy -- [`AdminGetDiscountsParams_base`](../modules/internal-7.md#admingetdiscountsparams_base) +- [`AdminGetDiscountsParams_base`](../modules/internal-8.md#admingetdiscountsparams_base) ↳ **`AdminGetDiscountsParams`** @@ -20,7 +24,7 @@ AdminGetDiscountsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -34,7 +38,7 @@ AdminGetDiscountsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 ___ @@ -44,7 +48,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:92 +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:82 ___ @@ -54,7 +58,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:91 +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:81 ___ @@ -68,7 +72,7 @@ AdminGetDiscountsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -82,7 +86,7 @@ AdminGetDiscountsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -92,14 +96,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:90 +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:80 ___ ### rule -• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-7.AdminGetDiscountsDiscountRuleParams.md) +• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-8.AdminGetDiscountsDiscountRuleParams.md) #### Defined in -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:89 +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md deleted file mode 100644 index 3120fa7ebc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminGetDraftOrdersParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminGetDraftOrdersParams - -[internal](../modules/internal-8.md).AdminGetDraftOrdersParams - -## Properties - -### limit - -• `Optional` **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:70 - -___ - -### offset - -• `Optional` **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:71 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md similarity index 64% rename from www/apps/docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md index 98b362a216..14219f4da7 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-14.AdminListOrdersSelector.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminListOrdersSelector.md @@ -1,12 +1,16 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminListOrdersSelector -[internal](../modules/internal-14.md).AdminListOrdersSelector +[internal](../modules/internal-8.md).AdminListOrdersSelector ## Hierarchy - **`AdminListOrdersSelector`** - ↳ [`AdminGetOrdersParams`](internal-14.AdminGetOrdersParams.md) + ↳ [`AdminGetOrdersParams`](internal-8.internal.AdminGetOrdersParams.md) ## Properties @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/types/orders.d.ts:93 +packages/medusa/dist/types/orders.d.ts:101 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:86 +packages/medusa/dist/types/orders.d.ts:94 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:94 +packages/medusa/dist/types/orders.d.ts:102 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:90 +packages/medusa/dist/types/orders.d.ts:98 ___ @@ -56,7 +60,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:87 +packages/medusa/dist/types/orders.d.ts:95 ___ @@ -66,7 +70,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:85 +packages/medusa/dist/types/orders.d.ts:93 ___ @@ -76,7 +80,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:88 +packages/medusa/dist/types/orders.d.ts:96 ___ @@ -86,7 +90,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:83 +packages/medusa/dist/types/orders.d.ts:91 ___ @@ -96,7 +100,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:81 +packages/medusa/dist/types/orders.d.ts:89 ___ @@ -106,7 +110,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:84 +packages/medusa/dist/types/orders.d.ts:92 ___ @@ -116,7 +120,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:80 +packages/medusa/dist/types/orders.d.ts:88 ___ @@ -126,7 +130,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:89 +packages/medusa/dist/types/orders.d.ts:97 ___ @@ -136,7 +140,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:92 +packages/medusa/dist/types/orders.d.ts:100 ___ @@ -146,7 +150,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:82 +packages/medusa/dist/types/orders.d.ts:90 ___ @@ -156,7 +160,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:91 +packages/medusa/dist/types/orders.d.ts:99 ___ @@ -166,4 +170,4 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:95 +packages/medusa/dist/types/orders.d.ts:103 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md new file mode 100644 index 0000000000..72be00d831 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditions.md @@ -0,0 +1,131 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditions + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditions + +**`Schema`** + +AdminPostDiscountsDiscountConditions +type: object +required: + - operator +properties: + operator: + description: "Operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that + discountable resources are everything but the specified resources." + type: string + enum: [in, not_in] + products: + type: array + description: list of product IDs if the condition's type is `products`. + items: + type: string + product_types: + type: array + description: list of product type IDs if the condition's type is `product_types`. + items: + type: string + product_collections: + type: array + description: list of product collection IDs if the condition's type is `product_collections`. + items: + type: string + product_tags: + type: array + description: list of product tag IDs if the condition's type is `product_tags`. + items: + type: string + customer_groups: + type: array + description: list of customer group IDs if the condition's type is `customer_groups`. + items: + type: string + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-8.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditions`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[customer_groups](internal-8.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:113 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_collections](internal-8.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_tags](internal-8.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_types](internal-8.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[products](internal-8.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md new file mode 100644 index 0000000000..5542eb6025 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md @@ -0,0 +1,114 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditionsCondition + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsCondition + +**`Schema`** + +AdminPostDiscountsDiscountConditionsCondition +type: object +properties: + products: + type: array + description: list of product IDs if the condition's type is `products`. + items: + type: string + product_types: + type: array + description: list of product type IDs if the condition's type is `product_types`. + items: + type: string + product_collections: + type: array + description: list of product collection IDs if the condition's type is `product_collections`. + items: + type: string + product_tags: + type: array + description: list of product tag IDs if the condition's type is `product_tags` + items: + type: string + customer_groups: + type: array + description: list of customer group IDs if the condition's type is `customer_groups`. + items: + type: string + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-8.AdminUpsertConditionsReq.md) + + ↳ **`AdminPostDiscountsDiscountConditionsCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[customer_groups](internal-8.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_collections](internal-8.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_tags](internal-8.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_types](internal-8.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[products](internal-8.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md similarity index 53% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md index 14faddbb41..f27df453b6 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostDiscountsDiscountConditionsConditionBatchParams -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsConditionBatchParams +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsConditionBatchParams ## Hierarchy -- [`FindParams`](internal-5.FindParams.md) +- [`FindParams`](internal-6.FindParams.md) ↳ **`AdminPostDiscountsDiscountConditionsConditionBatchParams`** @@ -16,11 +20,11 @@ #### Inherited from -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -30,8 +34,8 @@ ___ #### Inherited from -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md new file mode 100644 index 0000000000..14a88e2508 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountConditionsConditionBatchReq + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsConditionBatchReq + +**`Schema`** + +AdminPostDiscountsDiscountConditionsConditionBatchReq +type: object +required: + - resources +properties: + resources: + description: The resources to be added to the discount condition + type: array + items: + type: object + required: + - id + properties: + id: + description: The id of the item + type: string + +## Properties + +### resources + +• **resources**: { `id`: `string` }[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/add-resources-to-condition-batch.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md similarity index 52% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md index a95b5cddb5..7e1140ee8c 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostDiscountsDiscountConditionsConditionParams -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsConditionParams +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsConditionParams ## Hierarchy -- [`FindParams`](internal-5.FindParams.md) +- [`FindParams`](internal-6.FindParams.md) ↳ **`AdminPostDiscountsDiscountConditionsConditionParams`** @@ -16,11 +20,11 @@ #### Inherited from -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -30,8 +34,8 @@ ___ #### Inherited from -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md similarity index 50% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md index 1e4f8ca503..33586c9db9 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPostDiscountsDiscountConditionsParams -[internal](../modules/internal-7.md).AdminPostDiscountsDiscountConditionsParams +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountConditionsParams ## Hierarchy -- [`FindParams`](internal-5.FindParams.md) +- [`FindParams`](internal-6.FindParams.md) ↳ **`AdminPostDiscountsDiscountConditionsParams`** @@ -16,11 +20,11 @@ #### Inherited from -[FindParams](internal-5.FindParams.md).[expand](internal-5.FindParams.md#expand) +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -30,8 +34,8 @@ ___ #### Inherited from -[FindParams](internal-5.FindParams.md).[fields](internal-5.FindParams.md#fields) +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md new file mode 100644 index 0000000000..3a26d26ee2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountDynamicCodesReq + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountDynamicCodesReq + +**`Schema`** + +AdminPostDiscountsDiscountDynamicCodesReq +type: object +required: + - code +properties: + code: + type: string + description: A unique code that will be used to redeem the Discount + usage_limit: + type: number + description: Maximum number of times the discount code can be used + default: 1 + metadata: + type: object + description: An optional set of key-value pairs to hold additional information. + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:89 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:91 + +___ + +### usage\_limit + +• **usage\_limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-dynamic-code.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md new file mode 100644 index 0000000000..be97f15c87 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountReq.md @@ -0,0 +1,195 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountReq + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountReq + +**`Schema`** + +AdminPostDiscountsDiscountReq +type: object +properties: + code: + type: string + description: A unique code that will be used to redeem the discount + rule: + description: The discount rule that defines how discounts are calculated + type: object + required: + - id + properties: + id: + type: string + description: "The ID of the Rule" + description: + type: string + description: "A short description of the discount" + value: + type: number + description: "The value that the discount represents. This will depend on the type of the discount." + allocation: + type: string + description: "The scope that the discount should apply to. `total` indicates that the discount should be applied on the cart total, and `item` indicates that the discount should be applied to each discountable item in the cart." + enum: [total, item] + conditions: + type: array + description: "A set of conditions that can be used to limit when the discount can be used. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided based on the discount condition's type." + items: + type: object + required: + - operator + properties: + id: + type: string + description: "The ID of the condition" + operator: + type: string + description: "Operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that + discountable resources are everything but the specified resources." + enum: [in, not_in] + products: + type: array + description: list of product IDs if the condition's type is `products`. + items: + type: string + product_types: + type: array + description: list of product type IDs if the condition's type is `product_types`. + items: + type: string + product_collections: + type: array + description: list of product collection IDs if the condition's type is `product_collections`. + items: + type: string + product_tags: + type: array + description: list of product tag IDs if the condition's type is `product_tags`. + items: + type: string + customer_groups: + type: array + description: list of customer group IDs if the condition's type is `customer_groups`. + items: + type: string + is_disabled: + type: boolean + description: Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers. + starts_at: + type: string + format: date-time + description: The date and time at which the discount should be available. + ends_at: + type: string + format: date-time + description: The date and time at which the discount should no longer be available. + valid_duration: + type: string + description: The duration the discount runs between + example: P3Y6M4DT12H30M5S + usage_limit: + type: number + description: Maximum number of times the discount can be used + regions: + description: A list of region IDs representing the Regions in which the Discount can be used. + type: array + items: + type: string + metadata: + description: An object containing metadata of the discount + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:171 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:175 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:173 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:179 + +___ + +### regions + +• `Optional` **regions**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:178 + +___ + +### rule + +• `Optional` **rule**: [`AdminUpdateDiscountRule`](internal-8.AdminUpdateDiscountRule.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:172 + +___ + +### starts\_at + +• `Optional` **starts\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:174 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:177 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:176 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md new file mode 100644 index 0000000000..82b419932a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsDiscountRule.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountRule + +[internal](../modules/internal-8.md).AdminPostDiscountsDiscountRule + +## Properties + +### allocation + +• **allocation**: [`AllocationType`](../enums/internal-3.AllocationType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:209 + +___ + +### conditions + +• `Optional` **conditions**: [`AdminCreateCondition`](internal-8.AdminCreateCondition.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:210 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:206 + +___ + +### type + +• **type**: [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:207 + +___ + +### value + +• **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:208 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsReq.md new file mode 100644 index 0000000000..40af346af9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDiscountsReq.md @@ -0,0 +1,214 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsReq + +[internal](../modules/internal-8.md).AdminPostDiscountsReq + +**`Schema`** + +AdminPostDiscountsReq +type: object +required: + - code + - rule + - regions +properties: + code: + type: string + description: A unique code that will be used to redeem the discount + is_dynamic: + type: boolean + description: Whether the discount should have multiple instances of itself, each with a different code. This can be useful for automatically generated discount codes that all have to follow a common set of rules. + default: false + rule: + description: The discount rule that defines how discounts are calculated + type: object + required: + - type + - value + - allocation + properties: + description: + type: string + description: "A short description of the discount" + type: + type: string + description: "The type of the discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers." + enum: [fixed, percentage, free_shipping] + value: + type: number + description: "The value that the discount represents. This will depend on the type of the discount." + allocation: + type: string + description: "The scope that the discount should apply to. `total` indicates that the discount should be applied on the cart total, and `item` indicates that the discount should be applied to each discountable item in the cart." + enum: [total, item] + conditions: + type: array + description: "A set of conditions that can be used to limit when the discount can be used. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided based on the discount condition's type." + items: + type: object + required: + - operator + properties: + operator: + type: string + description: "Operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that + discountable resources are everything but the specified resources." + enum: [in, not_in] + products: + type: array + description: list of product IDs if the condition's type is `products`. + items: + type: string + product_types: + type: array + description: list of product type IDs if the condition's type is `product_types`. + items: + type: string + product_collections: + type: array + description: list of product collection IDs if the condition's type is `product_collections`. + items: + type: string + product_tags: + type: array + description: list of product tag IDs if the condition's type is `product_tags`. + items: + type: string + customer_groups: + type: array + description: list of customer group IDs if the condition's type is `customer_groups`. + items: + type: string + is_disabled: + type: boolean + description: Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers. + default: false + starts_at: + type: string + format: date-time + description: The date and time at which the discount should be available. + ends_at: + type: string + format: date-time + description: The date and time at which the discount should no longer be available. + valid_duration: + type: string + description: The duration the discount runs between + example: P3Y6M4DT12H30M5S + regions: + description: A list of region IDs representing the Regions in which the Discount can be used. + type: array + items: + type: string + usage_limit: + type: number + description: Maximum number of times the discount can be used + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:194 + +___ + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:199 + +___ + +### is\_disabled + +• **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:197 + +___ + +### is\_dynamic + +• **is\_dynamic**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:196 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:203 + +___ + +### regions + +• **regions**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:202 + +___ + +### rule + +• **rule**: [`AdminPostDiscountsDiscountRule`](internal-8.AdminPostDiscountsDiscountRule.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:195 + +___ + +### starts\_at + +• `Optional` **starts\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:198 + +___ + +### usage\_limit + +• `Optional` **usage\_limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:201 + +___ + +### valid\_duration + +• `Optional` **valid\_duration**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:200 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md deleted file mode 100644 index fcc99aa5b6..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md +++ /dev/null @@ -1,43 +0,0 @@ -# Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq - -[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:84 - -___ - -### quantity - -• `Optional` **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:83 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:81 - -___ - -### unit\_price - -• `Optional` **unit\_price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md deleted file mode 100644 index 8897447c7c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminPostDraftOrdersDraftOrderLineItemsReq - -[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderLineItemsReq - -## Properties - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:90 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:89 - -___ - -### title - -• `Optional` **title**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:86 - -___ - -### unit\_price - -• `Optional` **unit\_price**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:87 - -___ - -### variant\_id - -• `Optional` **variant\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md deleted file mode 100644 index d0cce142ef..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md +++ /dev/null @@ -1,83 +0,0 @@ -# Class: AdminPostDraftOrdersDraftOrderReq - -[internal](../modules/internal-8.md).AdminPostDraftOrdersDraftOrderReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:112 - -___ - -### country\_code - -• `Optional` **country\_code**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:110 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:115 - -___ - -### discounts - -• `Optional` **discounts**: [`Discount`](internal-8.Discount-1.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:114 - -___ - -### email - -• `Optional` **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:111 - -___ - -### no\_notification\_order - -• `Optional` **no\_notification\_order**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:116 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:109 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:113 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersReq.md deleted file mode 100644 index 160131c0b5..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPostDraftOrdersReq.md +++ /dev/null @@ -1,113 +0,0 @@ -# Class: AdminPostDraftOrdersReq - -[internal](../modules/internal-8.md).AdminPostDraftOrdersReq - -## Properties - -### billing\_address - -• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:177 - -___ - -### customer\_id - -• `Optional` **customer\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:182 - -___ - -### discounts - -• `Optional` **discounts**: [`Discount`](internal-8.Discount.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:181 - -___ - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:176 - -___ - -### items - -• **items**: [`Item`](internal-8.Item.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:179 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:185 - -___ - -### no\_notification\_order - -• `Optional` **no\_notification\_order**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:183 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:180 - -___ - -### shipping\_address - -• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:178 - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](internal-8.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:184 - -___ - -### status - -• `Optional` **status**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:175 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md new file mode 100644 index 0000000000..632c99a86a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminPriceSelectionParams.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPriceSelectionParams + +[internal](../modules/internal-8.md).AdminPriceSelectionParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-8.PriceSelectionParams.md) + + ↳ **`AdminPriceSelectionParams`** + + ↳↳ [`AdminGetVariantsParams`](internal-8.internal.AdminGetVariantsParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[cart_id](internal-8.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[currency_code](internal-8.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:8 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[expand](internal-8.PriceSelectionParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[fields](internal-8.PriceSelectionParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[region_id](internal-8.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md new file mode 100644 index 0000000000..a0755472dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminProductCategoriesReqBase.md @@ -0,0 +1,65 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminProductCategoriesReqBase + +[internal](../modules/internal-8.md).AdminProductCategoriesReqBase + +## Hierarchy + +- **`AdminProductCategoriesReqBase`** + + ↳ [`AdminPostProductCategoriesReq`](internal-8.internal.AdminPostProductCategoriesReq.md) + + ↳ [`AdminPostProductCategoriesCategoryReq`](internal-8.internal.AdminPostProductCategoriesCategoryReq.md) + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:18 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:19 + +___ + +### is\_active + +• `Optional` **is\_active**: `boolean` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:21 + +___ + +### is\_internal + +• `Optional` **is\_internal**: `boolean` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:20 + +___ + +### parent\_category\_id + +• `Optional` **parent\_category\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md new file mode 100644 index 0000000000..29b977c00c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpdateDiscountRule.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpdateDiscountRule + +[internal](../modules/internal-8.md).AdminUpdateDiscountRule + +## Properties + +### allocation + +• `Optional` **allocation**: [`AllocationType`](../enums/internal-3.AllocationType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:185 + +___ + +### conditions + +• `Optional` **conditions**: [`AdminUpsertCondition`](internal-8.AdminUpsertCondition.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:186 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:183 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:182 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:184 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md new file mode 100644 index 0000000000..79b204ec8b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertCondition.md @@ -0,0 +1,103 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpsertCondition + +[internal](../modules/internal-8.md).AdminUpsertCondition + +## Hierarchy + +- [`AdminUpsertConditionsReq`](internal-8.AdminUpsertConditionsReq.md) + + ↳ **`AdminUpsertCondition`** + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[customer_groups](internal-8.AdminUpsertConditionsReq.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:21 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:189 + +___ + +### operator + +• **operator**: [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/update-discount.d.ts:190 + +___ + +### product\_collections + +• `Optional` **product\_collections**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_collections](internal-8.AdminUpsertConditionsReq.md#product_collections) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:18 + +___ + +### product\_tags + +• `Optional` **product\_tags**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_tags](internal-8.AdminUpsertConditionsReq.md#product_tags) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:20 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[product_types](internal-8.AdminUpsertConditionsReq.md#product_types) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:19 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Inherited from + +[AdminUpsertConditionsReq](internal-8.AdminUpsertConditionsReq.md).[products](internal-8.AdminUpsertConditionsReq.md#products) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md similarity index 53% rename from www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md rename to www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md index d0f82dc29d..eb89d4d10e 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-7.AdminUpsertConditionsReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.AdminUpsertConditionsReq.md @@ -1,18 +1,22 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminUpsertConditionsReq -[internal](../modules/internal-7.md).AdminUpsertConditionsReq +[internal](../modules/internal-8.md).AdminUpsertConditionsReq ## Hierarchy - **`AdminUpsertConditionsReq`** - ↳ [`AdminPostDiscountsDiscountConditions`](internal-7.AdminPostDiscountsDiscountConditions.md) + ↳ [`AdminPostDiscountsDiscountConditions`](internal-8.AdminPostDiscountsDiscountConditions.md) - ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-7.AdminPostDiscountsDiscountConditionsCondition.md) + ↳ [`AdminPostDiscountsDiscountConditionsCondition`](internal-8.AdminPostDiscountsDiscountConditionsCondition.md) - ↳ [`AdminCreateCondition`](internal-7.AdminCreateCondition.md) + ↳ [`AdminCreateCondition`](internal-8.AdminCreateCondition.md) - ↳ [`AdminUpsertCondition`](internal-7.AdminUpsertCondition.md) + ↳ [`AdminUpsertCondition`](internal-8.AdminUpsertCondition.md) ## Properties @@ -22,7 +26,7 @@ #### Defined in -medusa/dist/types/discount.d.ts:20 +packages/medusa/dist/types/discount.d.ts:21 ___ @@ -32,7 +36,7 @@ ___ #### Defined in -medusa/dist/types/discount.d.ts:17 +packages/medusa/dist/types/discount.d.ts:18 ___ @@ -42,7 +46,7 @@ ___ #### Defined in -medusa/dist/types/discount.d.ts:19 +packages/medusa/dist/types/discount.d.ts:20 ___ @@ -52,7 +56,7 @@ ___ #### Defined in -medusa/dist/types/discount.d.ts:18 +packages/medusa/dist/types/discount.d.ts:19 ___ @@ -62,4 +66,4 @@ ___ #### Defined in -medusa/dist/types/discount.d.ts:16 +packages/medusa/dist/types/discount.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Blob.md b/www/apps/docs/content/references/js-client/classes/internal-8.Blob.md new file mode 100644 index 0000000000..420fe345be --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Blob.md @@ -0,0 +1,137 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Blob + +[internal](../modules/internal-8.md).Blob + +A [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) encapsulates immutable, raw data that can be safely shared across +multiple worker threads. + +**`Since`** + +v15.7.0, v14.18.0 + +## Properties + +### size + +• `Readonly` **size**: `number` + +The total size of the `Blob` in bytes. + +**`Since`** + +v15.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:142 + +___ + +### type + +• `Readonly` **type**: `string` + +The content-type of the `Blob`. + +**`Since`** + +v15.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:147 + +## Methods + +### arrayBuffer + +▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\> + +Returns a promise that fulfills with an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) containing a copy of +the `Blob` data. + +#### Returns + +`Promise`<`ArrayBuffer`\> + +**`Since`** + +v15.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:162 + +___ + +### slice + +▸ **slice**(`start?`, `end?`, `type?`): [`Blob`](internal-8.Blob.md) + +Creates and returns a new `Blob` containing a subset of this `Blob` objects +data. The original `Blob` is not altered. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `start?` | `number` | The starting index. | +| `end?` | `number` | The ending index. | +| `type?` | `string` | The content-type for the new `Blob` | + +#### Returns + +[`Blob`](internal-8.Blob.md) + +**`Since`** + +v15.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:171 + +___ + +### stream + +▸ **stream**(): [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> + +Returns a new `ReadableStream` that allows the content of the `Blob` to be read. + +#### Returns + +[`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> + +**`Since`** + +v16.7.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:182 + +___ + +### text + +▸ **text**(): `Promise`<`string`\> + +Returns a promise that fulfills with the contents of the `Blob` decoded as a +UTF-8 string. + +#### Returns + +`Promise`<`string`\> + +**`Since`** + +v15.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:177 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md b/www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md new file mode 100644 index 0000000000..097b02d577 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.CustomShippingOption.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomShippingOption + +[internal](../modules/internal-8.md).CustomShippingOption + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:181 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:182 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md new file mode 100644 index 0000000000..0f860f3a9e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup-1.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroup + +[internal](../modules/internal-8.md).CustomerGroup + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:68 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md new file mode 100644 index 0000000000..d695aa7515 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroup.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroup + +[internal](../modules/internal-8.md).CustomerGroup + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md new file mode 100644 index 0000000000..5b014eb96a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.CustomerGroupUpdate.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroupUpdate + +[internal](../modules/internal-8.md).CustomerGroupUpdate + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:15 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/types/customer-groups.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md index e9b993a57f..134b6fb82b 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-1.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: Discount [internal](../modules/internal-8.md).Discount @@ -10,4 +14,4 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:119 +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:123 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md new file mode 100644 index 0000000000..7c80f57b67 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-2.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Discount + +[internal](../modules/internal-8.md).Discount + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:62 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md new file mode 100644 index 0000000000..3c23e75fb4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Discount-3.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Discount + +[internal](../modules/internal-8.md).Discount + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:29 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Discount.md b/www/apps/docs/content/references/js-client/classes/internal-8.Discount.md index 56ea800435..b8993bb57d 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Discount.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Discount.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: Discount [internal](../modules/internal-8.md).Discount @@ -10,4 +14,4 @@ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:193 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:202 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md b/www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md new file mode 100644 index 0000000000..cd33c624d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Duplex.md @@ -0,0 +1,4811 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Duplex + +[internal](../modules/internal-8.md).Duplex + +Duplex streams are streams that implement both the `Readable` and `Writable` interfaces. + +Examples of `Duplex` streams include: + +* `TCP sockets` +* `zlib streams` +* `crypto streams` + +**`Since`** + +v0.9.4 + +## Hierarchy + +- [`ReadableBase`](internal-8.ReadableBase.md) + + ↳ **`Duplex`** + + ↳↳ [`Transform`](internal-8.Transform.md) + +## Implements + +- [`WritableBase`](internal-8.WritableBase.md) + +## Properties + +### allowHalfOpen + +• **allowHalfOpen**: `boolean` + +If `false` then the stream will automatically end the writable side when the +readable side ends. Set initially by the `allowHalfOpen` constructor option, +which defaults to `true`. + +This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is +emitted. + +**`Since`** + +v0.9.4 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:881 + +___ + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[closed](internal-8.WritableBase.md#closed) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[closed](internal-8.ReadableBase.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:870 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `readable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[destroyed](internal-8.WritableBase.md#destroyed) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[destroyed](internal-8.ReadableBase.md#destroyed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:101 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[errored](internal-8.WritableBase.md#errored) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[errored](internal-8.ReadableBase.md#errored) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:871 + +___ + +### readable + +• **readable**: `boolean` + +Is `true` if it is safe to call `readable.read()`, which means +the stream has not been destroyed or emitted `'error'` or `'end'`. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readable](internal-8.ReadableBase.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:57 + +___ + +### readableAborted + +• `Readonly` **readableAborted**: `boolean` + +Returns whether the stream was destroyed or errored before emitting `'end'`. + +**`Since`** + +v16.8.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableAborted](internal-8.ReadableBase.md#readableaborted) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:51 + +___ + +### readableDidRead + +• `Readonly` **readableDidRead**: `boolean` + +Returns whether `'data'` has been emitted. + +**`Since`** + +v16.7.0, v14.18.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableDidRead](internal-8.ReadableBase.md#readabledidread) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:63 + +___ + +### readableEncoding + +• `Readonly` **readableEncoding**: ``null`` \| [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + +**`Since`** + +v12.7.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableEncoding](internal-8.ReadableBase.md#readableencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:68 + +___ + +### readableEnded + +• `Readonly` **readableEnded**: `boolean` + +Becomes `true` when `'end'` event is emitted. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableEnded](internal-8.ReadableBase.md#readableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:73 + +___ + +### readableFlowing + +• `Readonly` **readableFlowing**: ``null`` \| `boolean` + +This property reflects the current state of a `Readable` stream as described +in the `Three states` section. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableFlowing](internal-8.ReadableBase.md#readableflowing) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:79 + +___ + +### readableHighWaterMark + +• `Readonly` **readableHighWaterMark**: `number` + +Returns the value of `highWaterMark` passed when creating this `Readable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableHighWaterMark](internal-8.ReadableBase.md#readablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:84 + +___ + +### readableLength + +• `Readonly` **readableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableLength](internal-8.ReadableBase.md#readablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:91 + +___ + +### readableObjectMode + +• `Readonly` **readableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Readable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableObjectMode](internal-8.ReadableBase.md#readableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:96 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +Is `true` if it is safe to call `writable.write()`, which means +the stream has not been destroyed, errored, or ended. + +**`Since`** + +v11.4.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writable](internal-8.WritableBase.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:862 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +Number of times `writable.uncork()` needs to be +called in order to fully uncork the stream. + +**`Since`** + +v13.2.0, v12.16.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableCorked](internal-8.WritableBase.md#writablecorked) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:868 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +Is `true` after `writable.end()` has been called. This property +does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + +**`Since`** + +v12.9.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableEnded](internal-8.WritableBase.md#writableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:863 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +Is set to `true` immediately before the `'finish'` event is emitted. + +**`Since`** + +v12.6.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableFinished](internal-8.WritableBase.md#writablefinished) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:864 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +Return the value of `highWaterMark` passed when creating this `Writable`. + +**`Since`** + +v9.3.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableHighWaterMark](internal-8.WritableBase.md#writablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:865 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableLength](internal-8.WritableBase.md#writablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:866 + +___ + +### writableNeedDrain + +• `Readonly` **writableNeedDrain**: `boolean` + +Is `true` if the stream's buffer has been full and stream will emit `'drain'`. + +**`Since`** + +v15.2.0, v14.17.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableNeedDrain](internal-8.WritableBase.md#writableneeddrain) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:869 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Writable` stream. + +**`Since`** + +v12.3.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[writableObjectMode](internal-8.WritableBase.md#writableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:867 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[captureRejectionSymbol](internal-8.WritableBase.md#capturerejectionsymbol) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[captureRejectionSymbol](internal-8.ReadableBase.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[captureRejections](internal-8.WritableBase.md#capturerejections) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[captureRejections](internal-8.ReadableBase.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[defaultMaxListeners](internal-8.WritableBase.md#defaultmaxlisteners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[defaultMaxListeners](internal-8.ReadableBase.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[errorMonitor](internal-8.WritableBase.md#errormonitor) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[errorMonitor](internal-8.ReadableBase.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[[asyncIterator]](internal-8.ReadableBase.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:475 + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[_construct](internal-8.WritableBase.md#_construct) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[_construct](internal-8.ReadableBase.md#_construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:113 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[_destroy](internal-8.WritableBase.md#_destroy) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[_destroy](internal-8.ReadableBase.md#_destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:913 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[_final](internal-8.WritableBase.md#_final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:914 + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size` | `number` | + +#### Returns + +`void` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[_read](internal-8.ReadableBase.md#_read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:114 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[_write](internal-8.WritableBase.md#_write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:905 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[_writev](internal-8.WritableBase.md#_writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:906 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Event emitter +The defined events on documents including: +1. close +2. data +3. drain +4. end +5. error +6. finish +7. pause +8. pipe +9. readable +10. resume +11. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:959 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:960 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:961 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:962 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:963 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:964 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:965 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:966 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:967 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:968 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:969 + +▸ **addListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.addListener + +#### Overrides + +ReadableBase.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:970 + +___ + +### cork + +▸ **cork**(): `void` + +The `writable.cork()` method forces all written data to be buffered in memory. +The buffered data will be flushed when either the [uncork](internal-8.internal-2.Writable.md#uncork) or [end](internal-8.internal-2.Writable.md#end) methods are called. + +The primary intent of `writable.cork()` is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[cork](internal-8.WritableBase.md#cork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:921 + +___ + +### destroy + +▸ **destroy**(`error?`): [`Duplex`](internal-8.Duplex.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Error which will be passed as payload in `'error'` event | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v8.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[destroy](internal-8.WritableBase.md#destroy) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[destroy](internal-8.ReadableBase.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:407 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:971 + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `chunk` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:972 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:973 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:974 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:975 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:976 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:977 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Implementation of + +WritableBase.emit + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:978 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | + +#### Returns + +`boolean` + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:979 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | + +#### Returns + +`boolean` + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:980 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:981 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Implementation of + +WritableBase.emit + +#### Overrides + +ReadableBase.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:982 + +___ + +### end + +▸ **end**(`cb?`): [`Duplex`](internal-8.Duplex.md) + +Calling the `writable.end()` method signals that no more data will be written +to the `Writable`. The optional `chunk` and `encoding` arguments allow one +final additional chunk of data to be written immediately before closing the +stream. + +Calling the [write](internal-8.internal-2.Writable.md#write) method after calling [end](internal-8.internal-2.Writable.md#end) will raise an error. + +```js +// Write 'hello, ' and then end with 'world!'. +const fs = require('node:fs'); +const file = fs.createWriteStream('example.txt'); +file.write('hello, '); +file.end('world!'); +// Writing more now is not allowed! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:918 + +▸ **end**(`chunk`, `cb?`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:919 + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:920 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[eventNames](internal-8.WritableBase.md#eventnames) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[eventNames](internal-8.ReadableBase.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.Duplex.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[getMaxListeners](internal-8.WritableBase.md#getmaxlisteners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[getMaxListeners](internal-8.ReadableBase.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + +**`Since`** + +v0.11.14 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[isPaused](internal-8.ReadableBase.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:274 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[listenerCount](internal-8.WritableBase.md#listenercount) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listenerCount](internal-8.ReadableBase.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[listeners](internal-8.WritableBase.md#listeners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listeners](internal-8.ReadableBase.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v10.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[off](internal-8.WritableBase.md#off) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[off](internal-8.ReadableBase.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.1.101 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:983 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:984 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:985 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:986 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:987 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:988 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:989 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.on + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:990 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:991 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:992 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:993 + +▸ **on**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.on + +#### Overrides + +ReadableBase.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:994 + +___ + +### once + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.3.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:995 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:996 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:997 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:998 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:999 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1000 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1001 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.once + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1002 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1003 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1004 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1005 + +▸ **once**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.once + +#### Overrides + +ReadableBase.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1006 + +___ + +### pause + +▸ **pause**(): [`Duplex`](internal-8.Duplex.md) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[pause](internal-8.ReadableBase.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:238 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[pipe](internal-8.WritableBase.md#pipe) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[pipe](internal-8.ReadableBase.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1007 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1008 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1009 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1010 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1011 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1012 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1013 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1014 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1015 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1016 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1017 + +▸ **prependListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependListener + +#### Overrides + +ReadableBase.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1018 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1019 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1020 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1021 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1022 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1023 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1024 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1025 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1026 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1027 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1028 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1029 + +▸ **prependOnceListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.prependOnceListener + +#### Overrides + +ReadableBase.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1030 + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[push](internal-8.ReadableBase.md#push) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:394 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[rawListeners](internal-8.WritableBase.md#rawlisteners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[rawListeners](internal-8.ReadableBase.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +a call to `readable.read(size)`, regardless of the value of the`size` argument. + +If the `readable.read()` method returns a chunk of data, a `'data'` event will +also be emitted. + +Calling [read](internal-8.PassThrough.md#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size?` | `number` | Optional argument to specify how much data to read. | + +#### Returns + +`any` + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[read](internal-8.ReadableBase.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:191 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Duplex`](internal-8.Duplex.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeAllListeners](internal-8.WritableBase.md#removealllisteners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeAllListeners](internal-8.ReadableBase.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1031 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1032 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1033 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1034 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1035 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1036 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1037 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1038 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1039 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1040 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1041 + +▸ **removeListener**(`event`, `listener`): [`Duplex`](internal-8.Duplex.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +#### Implementation of + +WritableBase.removeListener + +#### Overrides + +ReadableBase.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1042 + +___ + +### resume + +▸ **resume**(): [`Duplex`](internal-8.Duplex.md) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[resume](internal-8.ReadableBase.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:257 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Duplex`](internal-8.Duplex.md) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The new default encoding | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.11.15 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[setDefaultEncoding](internal-8.WritableBase.md#setdefaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:917 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Duplex`](internal-8.Duplex.md) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding to use. | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setEncoding](internal-8.ReadableBase.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:216 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Duplex`](internal-8.Duplex.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.3.5 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[setMaxListeners](internal-8.WritableBase.md#setmaxlisteners) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setMaxListeners](internal-8.ReadableBase.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](internal-8.internal-2.Writable.md#cork) was called. + +When using `writable.cork()` and `writable.uncork()` to manage the buffering +of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[uncork](internal-8.WritableBase.md#uncork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:922 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Duplex`](internal-8.Duplex.md) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](internal-8.PassThrough.md#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `destination?` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) | Optional specific stream to unpipe | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[unpipe](internal-8.ReadableBase.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:301 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](internal-8.PassThrough.md#push), `stream.unshift(chunk)` will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if `readable.unshift()` is called during a +read (i.e. from within a [_read](internal-8.PassThrough.md#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](internal-8.PassThrough.md#push) will reset the reading state appropriately, +however it is best to simply avoid calling `readable.unshift()` while in the +process of performing a read. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. | + +#### Returns + +`void` + +**`Since`** + +v0.9.11 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[unshift](internal-8.ReadableBase.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:367 + +___ + +### wrap + +▸ **wrap**(`stream`): [`Duplex`](internal-8.Duplex.md) + +Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more +information.) + +When using an older Node.js library that emits `'data'` events and has a [pause](internal-8.PassThrough.md#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` +stream that uses +the old stream as its data source. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | An "old style" readable stream | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[wrap](internal-8.ReadableBase.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:393 + +___ + +### write + +▸ **write**(`chunk`, `encoding?`, `cb?`): `boolean` + +The `writable.write()` method writes some data to the stream, and calls the +supplied `callback` once the data has been fully handled. If an error +occurs, the `callback` will be called with the error as its +first argument. The `callback` is called asynchronously and before `'error'` is +emitted. + +The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. +If `false` is returned, further attempts to write data to the stream should +stop until the `'drain'` event is emitted. + +While a stream is not draining, calls to `write()` will buffer `chunk`, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the `'drain'` event will be emitted. +Once `write()` returns false, do not write more chunks +until the `'drain'` event is emitted. While calling `write()` on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability. + +Writing data while the stream is not draining is particularly +problematic for a `Transform`, because the `Transform` streams are paused +by default until they are piped or a `'data'` or `'readable'` event handler +is added. + +If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a `Readable` and use [pipe](internal-8.PassThrough.md#pipe). However, if calling `write()` is preferred, it is +possible to respect backpressure and avoid memory issues using the `'drain'` event: + +```js +function write(data, cb) { + if (!stream.write(data)) { + stream.once('drain', cb); + } else { + process.nextTick(cb); + } +} + +// Wait for cb to be called before doing any other write. +write('hello', () => { + console.log('Write completed, do more writes now.'); +}); +``` + +A `Writable` stream in object mode will always ignore the `encoding` argument. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Callback for when this chunk of data is flushed. | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | - | + +#### Returns + +`boolean` + +`false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + +**`Since`** + +v0.9.4 + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[write](internal-8.WritableBase.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:915 + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableBase](internal-8.WritableBase.md).[write](internal-8.WritableBase.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:916 + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating duplex streams. + +- `Stream` converts writable stream into writable `Duplex` and readable stream + to `Duplex`. +- `Blob` converts into readable `Duplex`. +- `string` converts into readable `Duplex`. +- `ArrayBuffer` converts into readable `Duplex`. +- `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`. +- `AsyncGeneratorFunction` converts into a readable/writable transform + `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield + `null`. +- `AsyncFunction` converts into a writable `Duplex`. Must return + either `null` or `undefined` +- `Object ({ writable, readable })` converts `readable` and + `writable` into `Stream` and then combines them into `Duplex` where the + `Duplex` will write to the `writable` and read from the `readable`. +- `Promise` converts into readable `Duplex`. Value `null` is ignored. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` \| [`Object`](../modules/internal-8.md#object) \| `Promise`<`any`\> \| `ArrayBuffer` \| [`Stream`](internal-8.Stream.md) \| [`Blob`](internal-8.Blob.md) \| [`Iterable`](../interfaces/internal-8.Iterable.md)<`any`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> \| [`AsyncGeneratorFunction`](../interfaces/internal-8.AsyncGeneratorFunction.md) | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v16.8.0 + +#### Overrides + +[ReadableBase](internal-8.ReadableBase.md).[from](internal-8.ReadableBase.md#from) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:904 + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `duplexStream` | `Object` | +| `duplexStream.readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `duplexStream.writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | +| `options?` | [`Pick`](../modules/internal-1.md#pick)<[`DuplexOptions`](../interfaces/internal-8.DuplexOptions.md), ``"signal"`` \| ``"allowHalfOpen"`` \| ``"decodeStrings"`` \| ``"encoding"`` \| ``"highWaterMark"`` \| ``"objectMode"``\> | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:937 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[getEventListeners](internal-8.ReadableBase.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v16.8.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[isDisturbed](internal-8.ReadableBase.md#isdisturbed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:45 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listenerCount](internal-8.ReadableBase.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setMaxListeners](internal-8.ReadableBase.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): `Object` + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streamDuplex` | [`Duplex`](internal-8.Duplex.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:928 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md new file mode 100644 index 0000000000..267ef8376c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.EventEmitter-1.md @@ -0,0 +1,1174 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: EventEmitter + +[internal](../modules/internal-8.md).EventEmitter + +The `EventEmitter` class is defined and exposed by the `node:events` module: + +```js +import { EventEmitter } from 'node:events'; +``` + +All `EventEmitter`s emit the event `'newListener'` when new listeners are +added and `'removeListener'` when existing listeners are removed. + +It supports the following option: + +**`Since`** + +v0.1.26 + +## Hierarchy + +- [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) + + ↳ **`EventEmitter`** + + ↳↳ [`internal`](internal-8.internal-5.md) + +## Properties + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[addListener](../interfaces/internal-8.EventEmitter-2.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[emit](../interfaces/internal-8.EventEmitter-2.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[eventNames](../interfaces/internal-8.EventEmitter-2.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.EventEmitter-1.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[getMaxListeners](../interfaces/internal-8.EventEmitter-2.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[listenerCount](../interfaces/internal-8.EventEmitter-2.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[listeners](../interfaces/internal-8.EventEmitter-2.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[off](../interfaces/internal-8.EventEmitter-2.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[on](../interfaces/internal-8.EventEmitter-2.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[once](../interfaces/internal-8.EventEmitter-2.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[prependListener](../interfaces/internal-8.EventEmitter-2.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[prependOnceListener](../interfaces/internal-8.EventEmitter-2.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[rawListeners](../interfaces/internal-8.EventEmitter-2.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[removeAllListeners](../interfaces/internal-8.EventEmitter-2.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[removeListener](../interfaces/internal-8.EventEmitter-2.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`EventEmitter`](internal-8.EventEmitter-1.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-1.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[EventEmitter](../interfaces/internal-8.EventEmitter-2.md).[setMaxListeners](../interfaces/internal-8.EventEmitter-2.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +NodeJS.EventEmitter.listenerCount + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +NodeJS.EventEmitter.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +NodeJS.EventEmitter.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +NodeJS.EventEmitter.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +NodeJS.EventEmitter.setMaxListeners + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md new file mode 100644 index 0000000000..ed06e36c45 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableCartProps.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableCartProps + +[internal](../modules/internal-8.md).FilterableCartProps + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:7 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:6 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md new file mode 100644 index 0000000000..67775bd958 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableDiscountProps.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableDiscountProps + +[internal](../modules/internal-8.md).FilterableDiscountProps + +## Properties + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:7 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:9 + +___ + +### is\_dynamic + +• `Optional` **is\_dynamic**: `boolean` + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:8 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:6 + +___ + +### rule + +• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal-8.AdminGetDiscountsDiscountRuleParams.md) + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md new file mode 100644 index 0000000000..f880643c18 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableLineItemAdjustmentProps.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableLineItemAdjustmentProps + +[internal](../modules/internal-8.md).FilterableLineItemAdjustmentProps + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:7 + +___ + +### description + +• `Optional` **description**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:5 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:3 + +___ + +### item\_id + +• `Optional` **item\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:4 + +___ + +### resource\_id + +• `Optional` **resource\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:6 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/line-item-adjustment.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.FilterableProductProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md similarity index 55% rename from www/apps/docs/content/references/js-client/classes/internal-20.FilterableProductProps.md rename to www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md index 677604ec15..1b31be4f72 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-20.FilterableProductProps.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductProps.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: FilterableProductProps -[internal](../modules/internal-20.md).FilterableProductProps +[internal](../modules/internal-8.md).FilterableProductProps API Level DTOs + Validation rules @@ -8,17 +12,27 @@ API Level DTOs + Validation rules - **`FilterableProductProps`** - ↳ [`AdminGetProductsParams`](internal-20.AdminGetProductsParams.md) + ↳ [`AdminGetProductsParams`](internal-8.internal.AdminGetProductsParams.md) ## Properties +### category\_id + +• `Optional` **category\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/types/product.d.ts:22 + +___ + ### collection\_id • `Optional` **collection\_id**: `string`[] #### Defined in -medusa/dist/types/product.d.ts:13 +packages/medusa/dist/types/product.d.ts:13 ___ @@ -28,7 +42,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:22 +packages/medusa/dist/types/product.d.ts:24 ___ @@ -38,7 +52,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:24 +packages/medusa/dist/types/product.d.ts:26 ___ @@ -48,7 +62,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:16 +packages/medusa/dist/types/product.d.ts:16 ___ @@ -58,7 +72,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:21 +packages/medusa/dist/types/product.d.ts:21 ___ @@ -68,7 +82,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:17 +packages/medusa/dist/types/product.d.ts:17 ___ @@ -78,7 +92,17 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:9 +packages/medusa/dist/types/product.d.ts:9 + +___ + +### include\_category\_children + +• `Optional` **include\_category\_children**: `boolean` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:23 ___ @@ -88,7 +112,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:18 +packages/medusa/dist/types/product.d.ts:18 ___ @@ -98,7 +122,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:12 +packages/medusa/dist/types/product.d.ts:12 ___ @@ -108,7 +132,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:10 +packages/medusa/dist/types/product.d.ts:10 ___ @@ -118,17 +142,17 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:20 +packages/medusa/dist/types/product.d.ts:20 ___ ### status -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] +• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md)[] #### Defined in -medusa/dist/types/product.d.ts:11 +packages/medusa/dist/types/product.d.ts:11 ___ @@ -138,7 +162,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:14 +packages/medusa/dist/types/product.d.ts:14 ___ @@ -148,7 +172,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:15 +packages/medusa/dist/types/product.d.ts:15 ___ @@ -158,7 +182,7 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:19 +packages/medusa/dist/types/product.d.ts:19 ___ @@ -168,4 +192,4 @@ ___ #### Defined in -medusa/dist/types/product.d.ts:23 +packages/medusa/dist/types/product.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md new file mode 100644 index 0000000000..d8c650b26f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FilterableProductVariantProps.md @@ -0,0 +1,217 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableProductVariantProps + +[internal](../modules/internal-8.md).FilterableProductVariantProps + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:96 + +___ + +### barcode + +• `Optional` **barcode**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:92 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:107 + +___ + +### ean + +• `Optional` **ean**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:93 + +___ + +### height + +• `Optional` **height**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:104 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:98 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:88 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:95 + +___ + +### length + +• `Optional` **length**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:103 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:97 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:101 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:100 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:99 + +___ + +### product\_id + +• `Optional` **product\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:90 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:106 + +___ + +### sku + +• `Optional` **sku**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:91 + +___ + +### title + +• `Optional` **title**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:89 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:94 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:108 + +___ + +### weight + +• `Optional` **weight**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:102 + +___ + +### width + +• `Optional` **width**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:105 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md b/www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md new file mode 100644 index 0000000000..c7a0a795ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FlagRouter.md @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FlagRouter + +[internal](../modules/internal-8.md).FlagRouter + +## Implements + +- [`IFlagRouter`](../interfaces/internal-8.IFlagRouter.md) + +## Properties + +### flags + +• `Private` `Readonly` **flags**: `any` + +#### Defined in + +packages/utils/dist/feature-flags/utils/flag-router.d.ts:3 + +## Methods + +### isFeatureEnabled + +▸ **isFeatureEnabled**(`flag`): `boolean` + +Check if a feature flag is enabled. +There are two ways of using this method: +1. `isFeatureEnabled("myFeatureFlag")` +2. `isFeatureEnabled({ myNestedFeatureFlag: "someNestedFlag" })` +We use 1. for top-level feature flags and 2. for nested feature flags. Almost all flags are top-level. +An example of a nested flag is workflows. To use it, you would do: +`isFeatureEnabled({ workflows: Workflows.CreateCart })` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `flag` | `string` \| [`Record`](../modules/internal.md#record)<`string`, `string`\> | The flag to check | + +#### Returns + +`boolean` + +- Whether the flag is enabled or not + +#### Implementation of + +[IFlagRouter](../interfaces/internal-8.IFlagRouter.md).[isFeatureEnabled](../interfaces/internal-8.IFlagRouter.md#isfeatureenabled) + +#### Defined in + +packages/utils/dist/feature-flags/utils/flag-router.d.ts:16 + +___ + +### listFlags + +▸ **listFlags**(): [`FeatureFlagsResponse`](../modules/internal-8.md#featureflagsresponse-1) + +#### Returns + +[`FeatureFlagsResponse`](../modules/internal-8.md#featureflagsresponse-1) + +#### Implementation of + +[IFlagRouter](../interfaces/internal-8.IFlagRouter.md).[listFlags](../interfaces/internal-8.IFlagRouter.md#listflags) + +#### Defined in + +packages/utils/dist/feature-flags/utils/flag-router.d.ts:30 + +___ + +### setFlag + +▸ **setFlag**(`key`, `value`): `void` + +Sets a feature flag. +Flags take two shapes: +setFlag("myFeatureFlag", true) +setFlag("myFeatureFlag", { nestedFlag: true }) +These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `key` | `string` | The key of the flag to set. | +| `value` | `boolean` \| { `[key: string]`: `boolean`; } | The value of the flag to set. | + +#### Returns + +`void` + +- void + +#### Defined in + +packages/utils/dist/feature-flags/utils/flag-router.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md b/www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md new file mode 100644 index 0000000000..728f1a226f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.FulfillmentService.md @@ -0,0 +1,452 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentService + +[internal](../modules/internal-8.md).FulfillmentService + +Handles Fulfillments + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`FulfillmentService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:31 + +___ + +### fulfillmentRepository\_ + +• `Protected` `Readonly` **fulfillmentRepository\_**: `Repository`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:32 + +___ + +### lineItemRepository\_ + +• `Protected` `Readonly` **lineItemRepository\_**: `Repository`<[`LineItem`](internal-3.LineItem.md)\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](internal-3.ReturnItem.md) }[]\> } + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:34 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:29 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:35 + +___ + +### shippingProfileService\_ + +• `Protected` `Readonly` **shippingProfileService\_**: [`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:30 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:28 + +___ + +### trackingLinkRepository\_ + +• `Protected` `Readonly` **trackingLinkRepository\_**: `Repository`<[`TrackingLink`](internal-3.TrackingLink.md)\> + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:33 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +Cancels a fulfillment with the fulfillment provider. Will decrement the +fulfillment_quantity on the line items associated with the fulfillment. +Throws if the fulfillment has already been shipped. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentOrId` | `string` \| [`Fulfillment`](internal-3.Fulfillment.md) | the fulfillment object or id. | + +#### Returns + +`Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +the result of the save operation + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:87 + +___ + +### createFulfillment + +▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](internal-3.Fulfillment.md)[]\> + +Creates an order fulfillment +If items needs to be fulfilled by different provider, we make +sure to partition those items, and create fulfillment for +those partitions. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`CreateFulfillmentOrder`](../modules/internal-8.md#createfulfillmentorder) | order to create fulfillment for | +| `itemsToFulfill` | [`FulFillmentItemType`](../modules/internal-8.md#fulfillmentitemtype)[] | the items in the order to fulfill | +| `custom?` | [`Partial`](../modules/internal-8.md#partial)<[`Fulfillment`](internal-3.Fulfillment.md)\> | potential custom values to add | + +#### Returns + +`Promise`<[`Fulfillment`](internal-3.Fulfillment.md)[]\> + +the created fulfillments + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:78 + +___ + +### createShipment + +▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +Creates a shipment by marking a fulfillment as shipped. Adds +tracking links and potentially more metadata. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentId` | `string` | the fulfillment to ship | +| `trackingLinks?` | { `tracking_number`: `string` }[] | tracking links for the shipment | +| `config?` | [`CreateShipmentConfig`](../modules/internal-8.md#createshipmentconfig) | potential configuration settings, such as no_notification and metadata | + +#### Returns + +`Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +the shipped fulfillment + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:96 + +___ + +### getFulfillmentItems\_ + +▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](internal-3.LineItem.md))[]\> + +Retrieves the order line items, given an array of items. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`CreateFulfillmentOrder`](../modules/internal-8.md#createfulfillmentorder) | the order to get line items from | +| `items` | [`FulFillmentItemType`](../modules/internal-8.md#fulfillmentitemtype)[] | the items to get | + +#### Returns + +`Promise`<(``null`` \| [`LineItem`](internal-3.LineItem.md))[]\> + +the line items generated by the transformer. + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:48 + +___ + +### partitionItems\_ + +▸ **partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../modules/internal-8.md#fulfillmentitempartition)[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `shippingMethods` | [`ShippingMethod`](internal-3.ShippingMethod.md)[] | +| `items` | [`LineItem`](internal-3.LineItem.md)[] | + +#### Returns + +[`FulfillmentItemPartition`](../modules/internal-8.md#fulfillmentitempartition)[] + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:37 + +___ + +### retrieve + +▸ **retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +Retrieves a fulfillment by its id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentId` | `string` | the id of the fulfillment to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Fulfillment`](internal-3.Fulfillment.md)\> | optional values to include with fulfillmentRepository query | + +#### Returns + +`Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +the fulfillment + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:67 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### validateFulfillmentLineItem\_ + +▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](internal-3.LineItem.md) + +Checks that a given quantity of a line item can be fulfilled. Fails if the +fulfillable quantity is lower than the requested fulfillment quantity. +Fulfillable quantity is calculated by subtracting the already fulfilled +quantity from the quantity that was originally purchased. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `item` | `undefined` \| [`LineItem`](internal-3.LineItem.md) | the line item to check has sufficient fulfillable quantity. | +| `quantity` | `number` | the quantity that is requested to be fulfilled. | + +#### Returns + +``null`` \| [`LineItem`](internal-3.LineItem.md) + +a line item that has the requested fulfillment quantity + set. + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:60 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`FulfillmentService`](internal-8.FulfillmentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`FulfillmentService`](internal-8.FulfillmentService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md new file mode 100644 index 0000000000..f89222f3b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard-1.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCard + +[internal](../modules/internal-8.md).GiftCard + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:26 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md b/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md new file mode 100644 index 0000000000..ebd01aa184 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.GiftCard.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCard + +[internal](../modules/internal-8.md).GiftCard + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Image.md b/www/apps/docs/content/references/js-client/classes/internal-8.Image.md new file mode 100644 index 0000000000..ab928365f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Image.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Image + +[internal](../modules/internal-8.md).Image + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:184 + +___ + +### url + +• `Optional` **url**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:185 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md new file mode 100644 index 0000000000..1a9a19d881 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-1.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### images + +• `Optional` **images**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:223 + +___ + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:218 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:220 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:219 + +___ + +### reason + +• `Optional` **reason**: [`ClaimReason`](../enums/internal-3.ClaimReason.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:221 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:222 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md new file mode 100644 index 0000000000..2fc3c219ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-2.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:127 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:128 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md new file mode 100644 index 0000000000..ffca8819cd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-3.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:176 + +___ + +### images + +• **images**: [`Image`](internal-8.Image.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:179 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:181 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:177 + +___ + +### reason + +• `Optional` **reason**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:178 + +___ + +### tags + +• **tags**: [`Tag`](internal-8.Tag.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:180 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md new file mode 100644 index 0000000000..d6db3bf499 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-4.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:76 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:77 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md new file mode 100644 index 0000000000..02ff813b28 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-5.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:74 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:77 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:75 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md new file mode 100644 index 0000000000..a3d2fe5f13 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item-6.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).Item + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:89 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:92 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:90 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:91 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Item.md b/www/apps/docs/content/references/js-client/classes/internal-8.Item.md index c5b760c27a..d9ffdbfbeb 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.Item.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Item.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: Item [internal](../modules/internal-8.md).Item @@ -6,11 +10,11 @@ ### metadata -• `Optional` **metadata**: `Record`<`string`, `unknown`\> +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:200 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:209 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:199 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:208 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:196 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:205 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:197 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:206 ___ @@ -50,4 +54,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:198 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:207 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md b/www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md new file mode 100644 index 0000000000..319564a90f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.MedusaError.md @@ -0,0 +1,205 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: MedusaError + +[internal](../modules/internal-8.md).MedusaError + +Standardized error to be used across Medusa project. + +## Hierarchy + +- [`Error`](../modules/internal-8.md#error) + + ↳ **`MedusaError`** + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:29 + +___ + +### date + +• **date**: `Date` + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:30 + +___ + +### message + +• **message**: `string` + +#### Overrides + +Error.message + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:28 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### type + +• **type**: `string` + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:27 + +___ + +### Codes + +▪ `Static` **Codes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CART_INCOMPATIBLE_STATE` | `string` | +| `INSUFFICIENT_INVENTORY` | `string` | + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:44 + +___ + +### Types + +▪ `Static` **Types**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `CONFLICT` | `string` | - | +| `DB_ERROR` | `string` | Errors stemming from the database | +| `DUPLICATE_ERROR` | `string` | - | +| `INVALID_ARGUMENT` | `string` | - | +| `INVALID_DATA` | `string` | - | +| `NOT_ALLOWED` | `string` | - | +| `NOT_FOUND` | `string` | - | +| `PAYMENT_AUTHORIZATION_ERROR` | `string` | - | +| `UNAUTHORIZED` | `string` | - | +| `UNEXPECTED_STATE` | `string` | - | + +#### Defined in + +packages/medusa-core-utils/dist/errors.d.ts:31 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: [`Error`](../modules/internal-8.md#error), `stackTraces`: [`CallSite`](../interfaces/internal-8.CallSite.md)[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Error`](../modules/internal-8.md#error) | +| `stackTraces` | [`CallSite`](../interfaces/internal-8.CallSite.md)[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md b/www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md new file mode 100644 index 0000000000..9cab991ca7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.NotificationProvider.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NotificationProvider + +[internal](../modules/internal-8.md).NotificationProvider + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/notification-provider.d.ts:2 + +___ + +### is\_installed + +• **is\_installed**: `boolean` + +#### Defined in + +packages/medusa/dist/models/notification-provider.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md new file mode 100644 index 0000000000..3ba76ccdfd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement-1.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OptionRequirement + +[internal](../modules/internal-8.md).OptionRequirement + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:81 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:79 + +___ + +### type + +• **type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md b/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md new file mode 100644 index 0000000000..613179f9dd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.OptionRequirement.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OptionRequirement + +[internal](../modules/internal-8.md).OptionRequirement + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:75 + +___ + +### type + +• **type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md similarity index 53% rename from www/apps/docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md rename to www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md index 6573dd934d..b22f21c109 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-14.OrdersReturnItem.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.OrdersReturnItem.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: OrdersReturnItem -[internal](../modules/internal-14.md).OrdersReturnItem +[internal](../modules/internal-8.md).OrdersReturnItem ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/orders.d.ts:98 +packages/medusa/dist/types/orders.d.ts:106 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:101 +packages/medusa/dist/types/orders.d.ts:109 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:99 +packages/medusa/dist/types/orders.d.ts:107 ___ @@ -40,4 +44,4 @@ ___ #### Defined in -medusa/dist/types/orders.d.ts:100 +packages/medusa/dist/types/orders.d.ts:108 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md b/www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md new file mode 100644 index 0000000000..9850e7131e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.PassThrough.md @@ -0,0 +1,4446 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PassThrough + +[internal](../modules/internal-8.md).PassThrough + +The `stream.PassThrough` class is a trivial implementation of a `Transform` stream that simply passes the input bytes across to the output. Its purpose is +primarily for examples and testing, but there are some use cases where`stream.PassThrough` is useful as a building block for novel sorts of streams. + +## Hierarchy + +- [`Transform`](internal-8.Transform.md) + + ↳ **`PassThrough`** + +## Properties + +### allowHalfOpen + +• **allowHalfOpen**: `boolean` + +If `false` then the stream will automatically end the writable side when the +readable side ends. Set initially by the `allowHalfOpen` constructor option, +which defaults to `true`. + +This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is +emitted. + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[allowHalfOpen](internal-8.Transform.md#allowhalfopen) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:881 + +___ + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[closed](internal-8.Transform.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:870 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `readable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[destroyed](internal-8.Transform.md#destroyed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:101 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[errored](internal-8.Transform.md#errored) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:871 + +___ + +### readable + +• **readable**: `boolean` + +Is `true` if it is safe to call `readable.read()`, which means +the stream has not been destroyed or emitted `'error'` or `'end'`. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readable](internal-8.Transform.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:57 + +___ + +### readableAborted + +• `Readonly` **readableAborted**: `boolean` + +Returns whether the stream was destroyed or errored before emitting `'end'`. + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableAborted](internal-8.Transform.md#readableaborted) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:51 + +___ + +### readableDidRead + +• `Readonly` **readableDidRead**: `boolean` + +Returns whether `'data'` has been emitted. + +**`Since`** + +v16.7.0, v14.18.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableDidRead](internal-8.Transform.md#readabledidread) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:63 + +___ + +### readableEncoding + +• `Readonly` **readableEncoding**: ``null`` \| [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + +**`Since`** + +v12.7.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableEncoding](internal-8.Transform.md#readableencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:68 + +___ + +### readableEnded + +• `Readonly` **readableEnded**: `boolean` + +Becomes `true` when `'end'` event is emitted. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableEnded](internal-8.Transform.md#readableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:73 + +___ + +### readableFlowing + +• `Readonly` **readableFlowing**: ``null`` \| `boolean` + +This property reflects the current state of a `Readable` stream as described +in the `Three states` section. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableFlowing](internal-8.Transform.md#readableflowing) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:79 + +___ + +### readableHighWaterMark + +• `Readonly` **readableHighWaterMark**: `number` + +Returns the value of `highWaterMark` passed when creating this `Readable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableHighWaterMark](internal-8.Transform.md#readablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:84 + +___ + +### readableLength + +• `Readonly` **readableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableLength](internal-8.Transform.md#readablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:91 + +___ + +### readableObjectMode + +• `Readonly` **readableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Readable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[readableObjectMode](internal-8.Transform.md#readableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:96 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +Is `true` if it is safe to call `writable.write()`, which means +the stream has not been destroyed, errored, or ended. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writable](internal-8.Transform.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:862 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +Number of times `writable.uncork()` needs to be +called in order to fully uncork the stream. + +**`Since`** + +v13.2.0, v12.16.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableCorked](internal-8.Transform.md#writablecorked) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:868 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +Is `true` after `writable.end()` has been called. This property +does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableEnded](internal-8.Transform.md#writableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:863 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +Is set to `true` immediately before the `'finish'` event is emitted. + +**`Since`** + +v12.6.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableFinished](internal-8.Transform.md#writablefinished) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:864 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +Return the value of `highWaterMark` passed when creating this `Writable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableHighWaterMark](internal-8.Transform.md#writablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:865 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableLength](internal-8.Transform.md#writablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:866 + +___ + +### writableNeedDrain + +• `Readonly` **writableNeedDrain**: `boolean` + +Is `true` if the stream's buffer has been full and stream will emit `'drain'`. + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableNeedDrain](internal-8.Transform.md#writableneeddrain) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:869 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Writable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[writableObjectMode](internal-8.Transform.md#writableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:867 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[captureRejectionSymbol](internal-8.Transform.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[captureRejections](internal-8.Transform.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Transform](internal-8.Transform.md).[defaultMaxListeners](internal-8.Transform.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[errorMonitor](internal-8.Transform.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Inherited from + +[Transform](internal-8.Transform.md).[[asyncIterator]](internal-8.Transform.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:475 + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_construct](internal-8.Transform.md#_construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:113 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_destroy](internal-8.Transform.md#_destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:913 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_final](internal-8.Transform.md#_final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:914 + +___ + +### \_flush + +▸ **_flush**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_flush](internal-8.Transform.md#_flush) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1076 + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size` | `number` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_read](internal-8.Transform.md#_read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:114 + +___ + +### \_transform + +▸ **_transform**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_transform](internal-8.Transform.md#_transform) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1075 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_write](internal-8.Transform.md#_write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:905 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Transform](internal-8.Transform.md).[_writev](internal-8.Transform.md#_writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:906 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Event emitter +The defined events on documents including: +1. close +2. data +3. drain +4. end +5. error +6. finish +7. pause +8. pipe +9. readable +10. resume +11. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:959 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:960 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:961 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:962 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:963 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:964 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:965 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:966 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:967 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:968 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:969 + +▸ **addListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[addListener](internal-8.Transform.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:970 + +___ + +### cork + +▸ **cork**(): `void` + +The `writable.cork()` method forces all written data to be buffered in memory. +The buffered data will be flushed when either the [uncork](internal-8.internal-2.Writable.md#uncork) or [end](internal-8.internal-2.Writable.md#end) methods are called. + +The primary intent of `writable.cork()` is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Transform](internal-8.Transform.md).[cork](internal-8.Transform.md#cork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:921 + +___ + +### destroy + +▸ **destroy**(`error?`): [`PassThrough`](internal-8.PassThrough.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Error which will be passed as payload in `'error'` event | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v8.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[destroy](internal-8.Transform.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:407 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:971 + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `chunk` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:972 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:973 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:974 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:975 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:976 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:977 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:978 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:979 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:980 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:981 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[emit](internal-8.Transform.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:982 + +___ + +### end + +▸ **end**(`cb?`): [`PassThrough`](internal-8.PassThrough.md) + +Calling the `writable.end()` method signals that no more data will be written +to the `Writable`. The optional `chunk` and `encoding` arguments allow one +final additional chunk of data to be written immediately before closing the +stream. + +Calling the [write](internal-8.internal-2.Writable.md#write) method after calling [end](internal-8.internal-2.Writable.md#end) will raise an error. + +```js +// Write 'hello, ' and then end with 'world!'. +const fs = require('node:fs'); +const file = fs.createWriteStream('example.txt'); +file.write('hello, '); +file.end('world!'); +// Writing more now is not allowed! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[end](internal-8.Transform.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:918 + +▸ **end**(`chunk`, `cb?`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[end](internal-8.Transform.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:919 + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[end](internal-8.Transform.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:920 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[eventNames](internal-8.Transform.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.PassThrough.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[getMaxListeners](internal-8.Transform.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + +**`Since`** + +v0.11.14 + +#### Inherited from + +[Transform](internal-8.Transform.md).[isPaused](internal-8.Transform.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:274 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[listenerCount](internal-8.Transform.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Transform](internal-8.Transform.md).[listeners](internal-8.Transform.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[off](internal-8.Transform.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:983 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:984 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:985 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:986 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:987 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:988 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:989 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:990 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:991 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:992 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:993 + +▸ **on**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:994 + +___ + +### once + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:995 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:996 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:997 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:998 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:999 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1000 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1001 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1002 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1003 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1004 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1005 + +▸ **once**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1006 + +___ + +### pause + +▸ **pause**(): [`PassThrough`](internal-8.PassThrough.md) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[pause](internal-8.Transform.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:238 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[Transform](internal-8.Transform.md).[pipe](internal-8.Transform.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1007 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1008 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1009 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1010 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1011 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1012 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1013 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1014 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1015 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1016 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1017 + +▸ **prependListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependListener](internal-8.Transform.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1018 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1019 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1020 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1021 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1022 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1023 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1024 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1025 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1026 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1027 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1028 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1029 + +▸ **prependOnceListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[prependOnceListener](internal-8.Transform.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1030 + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[push](internal-8.Transform.md#push) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:394 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[rawListeners](internal-8.Transform.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +a call to `readable.read(size)`, regardless of the value of the`size` argument. + +If the `readable.read()` method returns a chunk of data, a `'data'` event will +also be emitted. + +Calling [read](internal-8.PassThrough.md#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size?` | `number` | Optional argument to specify how much data to read. | + +#### Returns + +`any` + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[read](internal-8.Transform.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:191 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`PassThrough`](internal-8.PassThrough.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeAllListeners](internal-8.Transform.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1031 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1032 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1033 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1034 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1035 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1036 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1037 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1038 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1039 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1040 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1041 + +▸ **removeListener**(`event`, `listener`): [`PassThrough`](internal-8.PassThrough.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +#### Inherited from + +[Transform](internal-8.Transform.md).[removeListener](internal-8.Transform.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1042 + +___ + +### resume + +▸ **resume**(): [`PassThrough`](internal-8.PassThrough.md) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[resume](internal-8.Transform.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:257 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`PassThrough`](internal-8.PassThrough.md) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The new default encoding | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.11.15 + +#### Inherited from + +[Transform](internal-8.Transform.md).[setDefaultEncoding](internal-8.Transform.md#setdefaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:917 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`PassThrough`](internal-8.PassThrough.md) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding to use. | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[setEncoding](internal-8.Transform.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:216 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`PassThrough`](internal-8.PassThrough.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[Transform](internal-8.Transform.md).[setMaxListeners](internal-8.Transform.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](internal-8.internal-2.Writable.md#cork) was called. + +When using `writable.cork()` and `writable.uncork()` to manage the buffering +of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Transform](internal-8.Transform.md).[uncork](internal-8.Transform.md#uncork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:922 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`PassThrough`](internal-8.PassThrough.md) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](internal-8.PassThrough.md#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `destination?` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) | Optional specific stream to unpipe | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[unpipe](internal-8.Transform.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:301 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](internal-8.PassThrough.md#push), `stream.unshift(chunk)` will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if `readable.unshift()` is called during a +read (i.e. from within a [_read](internal-8.PassThrough.md#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](internal-8.PassThrough.md#push) will reset the reading state appropriately, +however it is best to simply avoid calling `readable.unshift()` while in the +process of performing a read. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. | + +#### Returns + +`void` + +**`Since`** + +v0.9.11 + +#### Inherited from + +[Transform](internal-8.Transform.md).[unshift](internal-8.Transform.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:367 + +___ + +### wrap + +▸ **wrap**(`stream`): [`PassThrough`](internal-8.PassThrough.md) + +Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more +information.) + +When using an older Node.js library that emits `'data'` events and has a [pause](internal-8.PassThrough.md#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` +stream that uses +the old stream as its data source. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | An "old style" readable stream | + +#### Returns + +[`PassThrough`](internal-8.PassThrough.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[wrap](internal-8.Transform.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:393 + +___ + +### write + +▸ **write**(`chunk`, `encoding?`, `cb?`): `boolean` + +The `writable.write()` method writes some data to the stream, and calls the +supplied `callback` once the data has been fully handled. If an error +occurs, the `callback` will be called with the error as its +first argument. The `callback` is called asynchronously and before `'error'` is +emitted. + +The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. +If `false` is returned, further attempts to write data to the stream should +stop until the `'drain'` event is emitted. + +While a stream is not draining, calls to `write()` will buffer `chunk`, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the `'drain'` event will be emitted. +Once `write()` returns false, do not write more chunks +until the `'drain'` event is emitted. While calling `write()` on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability. + +Writing data while the stream is not draining is particularly +problematic for a `Transform`, because the `Transform` streams are paused +by default until they are piped or a `'data'` or `'readable'` event handler +is added. + +If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a `Readable` and use [pipe](internal-8.PassThrough.md#pipe). However, if calling `write()` is preferred, it is +possible to respect backpressure and avoid memory issues using the `'drain'` event: + +```js +function write(data, cb) { + if (!stream.write(data)) { + stream.once('drain', cb); + } else { + process.nextTick(cb); + } +} + +// Wait for cb to be called before doing any other write. +write('hello', () => { + console.log('Write completed, do more writes now.'); +}); +``` + +A `Writable` stream in object mode will always ignore the `encoding` argument. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Callback for when this chunk of data is flushed. | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | - | + +#### Returns + +`boolean` + +`false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Transform](internal-8.Transform.md).[write](internal-8.Transform.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:915 + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +[Transform](internal-8.Transform.md).[write](internal-8.Transform.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:916 + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating duplex streams. + +- `Stream` converts writable stream into writable `Duplex` and readable stream + to `Duplex`. +- `Blob` converts into readable `Duplex`. +- `string` converts into readable `Duplex`. +- `ArrayBuffer` converts into readable `Duplex`. +- `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`. +- `AsyncGeneratorFunction` converts into a readable/writable transform + `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield + `null`. +- `AsyncFunction` converts into a writable `Duplex`. Must return + either `null` or `undefined` +- `Object ({ writable, readable })` converts `readable` and + `writable` into `Stream` and then combines them into `Duplex` where the + `Duplex` will write to the `writable` and read from the `readable`. +- `Promise` converts into readable `Duplex`. Value `null` is ignored. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` \| [`Object`](../modules/internal-8.md#object) \| `Promise`<`any`\> \| `ArrayBuffer` \| [`Stream`](internal-8.Stream.md) \| [`Blob`](internal-8.Blob.md) \| [`Iterable`](../interfaces/internal-8.Iterable.md)<`any`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> \| [`AsyncGeneratorFunction`](../interfaces/internal-8.AsyncGeneratorFunction.md) | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[from](internal-8.Transform.md#from) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:904 + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `duplexStream` | `Object` | +| `duplexStream.readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `duplexStream.writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | +| `options?` | [`Pick`](../modules/internal-1.md#pick)<[`DuplexOptions`](../interfaces/internal-8.DuplexOptions.md), ``"signal"`` \| ``"allowHalfOpen"`` \| ``"decodeStrings"`` \| ``"encoding"`` \| ``"highWaterMark"`` \| ``"objectMode"``\> | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v17.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[fromWeb](internal-8.Transform.md#fromweb) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:937 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[getEventListeners](internal-8.Transform.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[isDisturbed](internal-8.Transform.md#isdisturbed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:45 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Transform](internal-8.Transform.md).[listenerCount](internal-8.Transform.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[on](internal-8.Transform.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[Transform](internal-8.Transform.md).[once](internal-8.Transform.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[setMaxListeners](internal-8.Transform.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): `Object` + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streamDuplex` | [`Duplex`](internal-8.Duplex.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | + +**`Since`** + +v17.0.0 + +#### Inherited from + +[Transform](internal-8.Transform.md).[toWeb](internal-8.Transform.md#toweb) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:928 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md b/www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md new file mode 100644 index 0000000000..6aa066002d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.PaymentMethod.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentMethod + +[internal](../modules/internal-8.md).PaymentMethod + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:148 + +___ + +### provider\_id + +• `Optional` **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:147 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md b/www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md new file mode 100644 index 0000000000..e02e8cb260 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.PaymentService.md @@ -0,0 +1,366 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentService + +[internal](../modules/internal-8.md).PaymentService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`PaymentService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:22 + +___ + +### paymentRepository\_ + +• `Protected` `Readonly` **paymentRepository\_**: `Repository`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:23 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `PAYMENT_CAPTURED` | `string` | +| `PAYMENT_CAPTURE_FAILED` | `string` | +| `REFUND_CREATED` | `string` | +| `REFUND_FAILED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:24 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### capture + +▸ **capture**(`paymentOrId`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +Captures a payment. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentOrId` | `string` \| [`Payment`](internal-3.Payment.md) | the id or the class instance of the payment | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +the payment captured. + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:61 + +___ + +### create + +▸ **create**(`paymentInput`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +Created a new payment. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentInput` | [`PaymentDataInput`](../modules/internal-8.md#paymentdatainput) | info to create the payment | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +the payment created. + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:45 + +___ + +### refund + +▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](internal-3.Refund.md)\> + +refunds a payment. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentOrId` | `string` \| [`Payment`](internal-3.Payment.md) | the id or the class instance of the payment | +| `amount` | `number` | the amount to be refunded from the payment | +| `reason` | `string` | the refund reason | +| `note?` | `string` | additional note of the refund | + +#### Returns + +`Promise`<[`Refund`](internal-3.Refund.md)\> + +the refund created. + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:70 + +___ + +### retrieve + +▸ **retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +Retrieves a payment by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentId` | `string` | the id of the payment | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Payment`](internal-3.Payment.md)\> | the config to retrieve the payment | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +the payment. + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:39 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`paymentId`, `data`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +Updates a payment in order to link it to an order or a swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentId` | `string` | the id of the payment | +| `data` | `Object` | order_id or swap_id to link the payment | +| `data.order_id?` | `string` | - | +| `data.swap_id?` | `string` | - | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +the payment updated. + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:52 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentService`](internal-8.PaymentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PaymentService`](internal-8.PaymentService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md new file mode 100644 index 0000000000..e5678ae755 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.PriceSelectionParams.md @@ -0,0 +1,79 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PriceSelectionParams + +[internal](../modules/internal-8.md).PriceSelectionParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`PriceSelectionParams`** + + ↳↳ [`StoreGetProductsPaginationParams`](internal-8.internal.StoreGetProductsPaginationParams.md) + + ↳↳ [`StoreGetVariantsVariantParams`](internal-8.internal.StoreGetVariantsVariantParams.md) + + ↳↳ [`StoreGetVariantsParams`](internal-8.internal.StoreGetVariantsParams.md) + + ↳↳ [`AdminPriceSelectionParams`](internal-8.AdminPriceSelectionParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md new file mode 100644 index 0000000000..d9fdd5b1f6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchProductCategory.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductBatchProductCategory + +[internal](../modules/internal-8.md).ProductBatchProductCategory + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md new file mode 100644 index 0000000000..4032559a31 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductBatchSalesChannel.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductBatchSalesChannel + +[internal](../modules/internal-8.md).ProductBatchSalesChannel + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/sales-channels.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md new file mode 100644 index 0000000000..108d4fb764 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductOptionReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductOptionReq + +[internal](../modules/internal-8.md).ProductOptionReq + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md new file mode 100644 index 0000000000..3a813dd196 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductProductCategoryReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductProductCategoryReq + +[internal](../modules/internal-8.md).ProductProductCategoryReq + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:151 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md new file mode 100644 index 0000000000..4735488419 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductSalesChannelReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductSalesChannelReq + +[internal](../modules/internal-8.md).ProductSalesChannelReq + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:148 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md new file mode 100644 index 0000000000..ba99498449 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductTagReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTagReq + +[internal](../modules/internal-8.md).ProductTagReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:154 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:155 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md new file mode 100644 index 0000000000..59f5d6c73d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductTypeReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTypeReq + +[internal](../modules/internal-8.md).ProductTypeReq + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:158 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/types/product.d.ts:159 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md new file mode 100644 index 0000000000..1d53de4e90 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-1.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantOptionReq + +[internal](../modules/internal-8.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:89 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md new file mode 100644 index 0000000000..eb6185c928 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-2.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantOptionReq + +[internal](../modules/internal-8.md).ProductVariantOptionReq + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md new file mode 100644 index 0000000000..49c6b7cf96 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq-3.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantOptionReq + +[internal](../modules/internal-8.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:71 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md new file mode 100644 index 0000000000..c23efd9c75 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantOptionReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantOptionReq + +[internal](../modules/internal-8.md).ProductVariantOptionReq + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:94 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:93 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md similarity index 54% rename from www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md rename to www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md index 5ac40ce858..03cfaf1b8f 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesCreateReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesCreateReq.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ProductVariantPricesCreateReq -[internal](../modules/internal-20.md).ProductVariantPricesCreateReq +[internal](../modules/internal-8.md).ProductVariantPricesCreateReq ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/product-variant.d.ts:100 +packages/medusa/dist/types/product-variant.d.ts:121 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:99 +packages/medusa/dist/types/product-variant.d.ts:120 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:102 +packages/medusa/dist/types/product-variant.d.ts:123 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:101 +packages/medusa/dist/types/product-variant.d.ts:122 ___ @@ -50,4 +54,4 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:98 +packages/medusa/dist/types/product-variant.d.ts:119 diff --git a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md similarity index 54% rename from www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md rename to www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md index 13eed0205e..2d7663efe6 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-20.ProductVariantPricesUpdateReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantPricesUpdateReq.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ProductVariantPricesUpdateReq -[internal](../modules/internal-20.md).ProductVariantPricesUpdateReq +[internal](../modules/internal-8.md).ProductVariantPricesUpdateReq ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/product-variant.d.ts:93 +packages/medusa/dist/types/product-variant.d.ts:114 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:92 +packages/medusa/dist/types/product-variant.d.ts:113 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:90 +packages/medusa/dist/types/product-variant.d.ts:111 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:95 +packages/medusa/dist/types/product-variant.d.ts:116 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:94 +packages/medusa/dist/types/product-variant.d.ts:115 ___ @@ -60,4 +64,4 @@ ___ #### Defined in -medusa/dist/types/product-variant.d.ts:91 +packages/medusa/dist/types/product-variant.d.ts:112 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md new file mode 100644 index 0000000000..5ace4e8fd5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq-1.md @@ -0,0 +1,207 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantReq + +[internal](../modules/internal-8.md).ProductVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:82 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:79 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:77 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:86 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:80 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:74 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:81 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:85 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:83 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:90 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:91 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:89 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-8.ProductVariantOptionReq-3.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:93 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:88 + +___ + +### prices + +• `Optional` **prices**: [`ProductVariantPricesUpdateReq`](internal-8.ProductVariantPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:92 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:76 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:75 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:78 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:84 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md new file mode 100644 index 0000000000..0bcd76542b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ProductVariantReq.md @@ -0,0 +1,197 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantReq + +[internal](../modules/internal-8.md).ProductVariantReq + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:83 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:80 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:78 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:87 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:81 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:82 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:86 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:84 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:91 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:92 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:90 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-8.ProductVariantOptionReq-2.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:94 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:89 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal-8.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:93 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:77 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:76 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:79 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:85 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Readable.md b/www/apps/docs/content/references/js-client/classes/internal-8.Readable.md new file mode 100644 index 0000000000..2a93808729 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Readable.md @@ -0,0 +1,3202 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Readable + +[internal](../modules/internal-8.md).Readable + +**`Since`** + +v0.9.4 + +## Hierarchy + +- [`ReadableBase`](internal-8.ReadableBase.md) + + ↳ **`Readable`** + +## Properties + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[closed](internal-8.ReadableBase.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:106 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `readable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[destroyed](internal-8.ReadableBase.md#destroyed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:101 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[errored](internal-8.ReadableBase.md#errored) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:111 + +___ + +### readable + +• **readable**: `boolean` + +Is `true` if it is safe to call `readable.read()`, which means +the stream has not been destroyed or emitted `'error'` or `'end'`. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readable](internal-8.ReadableBase.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:57 + +___ + +### readableAborted + +• `Readonly` **readableAborted**: `boolean` + +Returns whether the stream was destroyed or errored before emitting `'end'`. + +**`Since`** + +v16.8.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableAborted](internal-8.ReadableBase.md#readableaborted) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:51 + +___ + +### readableDidRead + +• `Readonly` **readableDidRead**: `boolean` + +Returns whether `'data'` has been emitted. + +**`Since`** + +v16.7.0, v14.18.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableDidRead](internal-8.ReadableBase.md#readabledidread) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:63 + +___ + +### readableEncoding + +• `Readonly` **readableEncoding**: ``null`` \| [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + +**`Since`** + +v12.7.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableEncoding](internal-8.ReadableBase.md#readableencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:68 + +___ + +### readableEnded + +• `Readonly` **readableEnded**: `boolean` + +Becomes `true` when `'end'` event is emitted. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableEnded](internal-8.ReadableBase.md#readableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:73 + +___ + +### readableFlowing + +• `Readonly` **readableFlowing**: ``null`` \| `boolean` + +This property reflects the current state of a `Readable` stream as described +in the `Three states` section. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableFlowing](internal-8.ReadableBase.md#readableflowing) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:79 + +___ + +### readableHighWaterMark + +• `Readonly` **readableHighWaterMark**: `number` + +Returns the value of `highWaterMark` passed when creating this `Readable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableHighWaterMark](internal-8.ReadableBase.md#readablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:84 + +___ + +### readableLength + +• `Readonly` **readableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableLength](internal-8.ReadableBase.md#readablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:91 + +___ + +### readableObjectMode + +• `Readonly` **readableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Readable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[readableObjectMode](internal-8.ReadableBase.md#readableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:96 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[captureRejectionSymbol](internal-8.ReadableBase.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[captureRejections](internal-8.ReadableBase.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[defaultMaxListeners](internal-8.ReadableBase.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[errorMonitor](internal-8.ReadableBase.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[[asyncIterator]](internal-8.ReadableBase.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:475 + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[_construct](internal-8.ReadableBase.md#_construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:113 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[_destroy](internal-8.ReadableBase.md#_destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:395 + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size` | `number` | + +#### Returns + +`void` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[_read](internal-8.ReadableBase.md#_read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:114 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Event emitter +The defined events on documents including: +1. close +2. data +3. end +4. error +5. pause +6. readable +7. resume + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:419 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:420 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:421 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:422 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:423 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:424 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:425 + +▸ **addListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[addListener](internal-8.ReadableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:426 + +___ + +### destroy + +▸ **destroy**(`error?`): [`Readable`](internal-8.Readable.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Error which will be passed as payload in `'error'` event | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v8.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[destroy](internal-8.ReadableBase.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:407 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:427 + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `chunk` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:428 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:429 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:430 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:431 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:432 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:433 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[emit](internal-8.ReadableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:434 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[eventNames](internal-8.ReadableBase.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.Readable.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[getMaxListeners](internal-8.ReadableBase.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + +**`Since`** + +v0.11.14 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[isPaused](internal-8.ReadableBase.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:274 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listenerCount](internal-8.ReadableBase.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listeners](internal-8.ReadableBase.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Readable`](internal-8.Readable.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[off](internal-8.ReadableBase.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:435 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:436 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:437 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:438 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:439 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:440 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:441 + +▸ **on**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:442 + +___ + +### once + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:443 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:444 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:445 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:446 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:447 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:448 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:449 + +▸ **once**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:450 + +___ + +### pause + +▸ **pause**(): [`Readable`](internal-8.Readable.md) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[pause](internal-8.ReadableBase.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:238 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[pipe](internal-8.ReadableBase.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:451 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:452 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:453 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:454 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:455 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:456 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:457 + +▸ **prependListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependListener](internal-8.ReadableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:458 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:459 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:460 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:461 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:462 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:463 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:464 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:465 + +▸ **prependOnceListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[prependOnceListener](internal-8.ReadableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:466 + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[push](internal-8.ReadableBase.md#push) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:394 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[rawListeners](internal-8.ReadableBase.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +a call to `readable.read(size)`, regardless of the value of the`size` argument. + +If the `readable.read()` method returns a chunk of data, a `'data'` event will +also be emitted. + +Calling [read](internal-8.PassThrough.md#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size?` | `number` | Optional argument to specify how much data to read. | + +#### Returns + +`any` + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[read](internal-8.ReadableBase.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:191 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Readable`](internal-8.Readable.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeAllListeners](internal-8.ReadableBase.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:467 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:468 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:469 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:470 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:471 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:472 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:473 + +▸ **removeListener**(`event`, `listener`): [`Readable`](internal-8.Readable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[removeListener](internal-8.ReadableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:474 + +___ + +### resume + +▸ **resume**(): [`Readable`](internal-8.Readable.md) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[resume](internal-8.ReadableBase.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:257 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Readable`](internal-8.Readable.md) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding to use. | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setEncoding](internal-8.ReadableBase.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:216 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Readable`](internal-8.Readable.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setMaxListeners](internal-8.ReadableBase.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Readable`](internal-8.Readable.md) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](internal-8.PassThrough.md#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `destination?` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) | Optional specific stream to unpipe | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[unpipe](internal-8.ReadableBase.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:301 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](internal-8.PassThrough.md#push), `stream.unshift(chunk)` will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if `readable.unshift()` is called during a +read (i.e. from within a [_read](internal-8.PassThrough.md#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](internal-8.PassThrough.md#push) will reset the reading state appropriately, +however it is best to simply avoid calling `readable.unshift()` while in the +process of performing a read. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. | + +#### Returns + +`void` + +**`Since`** + +v0.9.11 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[unshift](internal-8.ReadableBase.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:367 + +___ + +### wrap + +▸ **wrap**(`stream`): [`Readable`](internal-8.Readable.md) + +Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more +information.) + +When using an older Node.js library that emits `'data'` events and has a [pause](internal-8.PassThrough.md#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` +stream that uses +the old stream as its data source. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | An "old style" readable stream | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[wrap](internal-8.ReadableBase.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:393 + +___ + +### from + +▸ `Static` **from**(`iterable`, `options?`): [`Readable`](internal-8.Readable.md) + +A utility method for creating Readable Streams out of iterators. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iterable` | [`Iterable`](../interfaces/internal-8.Iterable.md)<`any`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> | +| `options?` | [`ReadableOptions`](../interfaces/internal-8.internal-2.ReadableOptions.md) | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[from](internal-8.ReadableBase.md#from) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:40 + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`readableStream`, `options?`): [`Readable`](internal-8.Readable.md) + +A utility method for creating a `Readable` from a web `ReadableStream`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `readableStream` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `options?` | [`Pick`](../modules/internal-1.md#pick)<[`ReadableOptions`](../interfaces/internal-8.internal-2.ReadableOptions.md), ``"signal"`` \| ``"encoding"`` \| ``"highWaterMark"`` \| ``"objectMode"``\> | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:791 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[getEventListeners](internal-8.ReadableBase.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v16.8.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[isDisturbed](internal-8.ReadableBase.md#isdisturbed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:45 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[listenerCount](internal-8.ReadableBase.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[on](internal-8.ReadableBase.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[once](internal-8.ReadableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[ReadableBase](internal-8.ReadableBase.md).[setMaxListeners](internal-8.ReadableBase.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamReadable`): [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> + +A utility method for creating a web `ReadableStream` from a `Readable`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streamReadable` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +[`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:797 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md new file mode 100644 index 0000000000..51f6872163 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReadableBase.md @@ -0,0 +1,3356 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReadableBase + +[internal](../modules/internal-8.md).ReadableBase + +The `EventEmitter` class is defined and exposed by the `node:events` module: + +```js +import { EventEmitter } from 'node:events'; +``` + +All `EventEmitter`s emit the event `'newListener'` when new listeners are +added and `'removeListener'` when existing listeners are removed. + +It supports the following option: + +**`Since`** + +v0.1.26 + +## Hierarchy + +- [`Stream`](internal-8.Stream.md) + + ↳ **`ReadableBase`** + + ↳↳ [`Duplex`](internal-8.Duplex.md) + + ↳↳ [`Readable`](internal-8.Readable.md) + +## Implements + +- [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) + +## Properties + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:106 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `readable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:101 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:111 + +___ + +### readable + +• **readable**: `boolean` + +Is `true` if it is safe to call `readable.read()`, which means +the stream has not been destroyed or emitted `'error'` or `'end'`. + +**`Since`** + +v11.4.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[readable](../interfaces/internal-8.ReadableStream.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:57 + +___ + +### readableAborted + +• `Readonly` **readableAborted**: `boolean` + +Returns whether the stream was destroyed or errored before emitting `'end'`. + +**`Since`** + +v16.8.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:51 + +___ + +### readableDidRead + +• `Readonly` **readableDidRead**: `boolean` + +Returns whether `'data'` has been emitted. + +**`Since`** + +v16.7.0, v14.18.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:63 + +___ + +### readableEncoding + +• `Readonly` **readableEncoding**: ``null`` \| [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + +**`Since`** + +v12.7.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:68 + +___ + +### readableEnded + +• `Readonly` **readableEnded**: `boolean` + +Becomes `true` when `'end'` event is emitted. + +**`Since`** + +v12.9.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:73 + +___ + +### readableFlowing + +• `Readonly` **readableFlowing**: ``null`` \| `boolean` + +This property reflects the current state of a `Readable` stream as described +in the `Three states` section. + +**`Since`** + +v9.4.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:79 + +___ + +### readableHighWaterMark + +• `Readonly` **readableHighWaterMark**: `number` + +Returns the value of `highWaterMark` passed when creating this `Readable`. + +**`Since`** + +v9.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:84 + +___ + +### readableLength + +• `Readonly` **readableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:91 + +___ + +### readableObjectMode + +• `Readonly` **readableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Readable` stream. + +**`Since`** + +v12.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:96 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[captureRejectionSymbol](internal-8.Stream.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[captureRejections](internal-8.Stream.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Stream](internal-8.Stream.md).[defaultMaxListeners](internal-8.Stream.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[errorMonitor](internal-8.Stream.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[[asyncIterator]](../interfaces/internal-8.ReadableStream.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:475 + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:113 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:395 + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:114 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Event emitter +The defined events on documents including: +1. close +2. data +3. end +4. error +5. pause +6. readable +7. resume + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[addListener](../interfaces/internal-8.ReadableStream.md#addlistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[addListener](internal-8.Stream.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:419 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:420 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:421 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:422 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:423 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:424 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:425 + +▸ **addListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:426 + +___ + +### destroy + +▸ **destroy**(`error?`): [`ReadableBase`](internal-8.ReadableBase.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Error which will be passed as payload in `'error'` event | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v8.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:407 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[emit](../interfaces/internal-8.ReadableStream.md#emit) + +#### Overrides + +[Stream](internal-8.Stream.md).[emit](internal-8.Stream.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:427 + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `chunk` | `any` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:428 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:429 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:430 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:431 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:432 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:433 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.ReadableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:434 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[eventNames](../interfaces/internal-8.ReadableStream.md#eventnames) + +#### Inherited from + +[Stream](internal-8.Stream.md).[eventNames](internal-8.Stream.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.ReadableBase.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[getMaxListeners](../interfaces/internal-8.ReadableStream.md#getmaxlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[getMaxListeners](internal-8.Stream.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + +**`Since`** + +v0.11.14 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[isPaused](../interfaces/internal-8.ReadableStream.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:274 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[listenerCount](../interfaces/internal-8.ReadableStream.md#listenercount) + +#### Inherited from + +[Stream](internal-8.Stream.md).[listenerCount](internal-8.Stream.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[listeners](../interfaces/internal-8.ReadableStream.md#listeners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[listeners](internal-8.Stream.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v10.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[off](../interfaces/internal-8.ReadableStream.md#off) + +#### Inherited from + +[Stream](internal-8.Stream.md).[off](internal-8.Stream.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.1.101 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[on](../interfaces/internal-8.ReadableStream.md#on) + +#### Overrides + +[Stream](internal-8.Stream.md).[on](internal-8.Stream.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:435 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:436 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:437 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:438 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:439 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:440 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:441 + +▸ **on**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:442 + +___ + +### once + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.3.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[once](../interfaces/internal-8.ReadableStream.md#once) + +#### Overrides + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:443 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:444 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:445 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:446 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:447 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:448 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:449 + +▸ **once**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:450 + +___ + +### pause + +▸ **pause**(): [`ReadableBase`](internal-8.ReadableBase.md) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[pause](../interfaces/internal-8.ReadableStream.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:238 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[pipe](../interfaces/internal-8.ReadableStream.md#pipe) + +#### Inherited from + +[Stream](internal-8.Stream.md).[pipe](internal-8.Stream.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[prependListener](../interfaces/internal-8.ReadableStream.md#prependlistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[prependListener](internal-8.Stream.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:451 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:452 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:453 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:454 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:455 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:456 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:457 + +▸ **prependListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:458 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[prependOnceListener](../interfaces/internal-8.ReadableStream.md#prependoncelistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[prependOnceListener](internal-8.Stream.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:459 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:460 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:461 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:462 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:463 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:464 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:465 + +▸ **prependOnceListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:466 + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:394 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[rawListeners](../interfaces/internal-8.ReadableStream.md#rawlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[rawListeners](internal-8.Stream.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +a call to `readable.read(size)`, regardless of the value of the`size` argument. + +If the `readable.read()` method returns a chunk of data, a `'data'` event will +also be emitted. + +Calling [read](internal-8.PassThrough.md#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size?` | `number` | Optional argument to specify how much data to read. | + +#### Returns + +`any` + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[read](../interfaces/internal-8.ReadableStream.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:191 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadableBase`](internal-8.ReadableBase.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[removeAllListeners](../interfaces/internal-8.ReadableStream.md#removealllisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[removeAllListeners](internal-8.Stream.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[removeListener](../interfaces/internal-8.ReadableStream.md#removelistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[removeListener](internal-8.Stream.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:467 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:468 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:469 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:470 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:471 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:472 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:473 + +▸ **removeListener**(`event`, `listener`): [`ReadableBase`](internal-8.ReadableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +#### Implementation of + +NodeJS.ReadableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:474 + +___ + +### resume + +▸ **resume**(): [`ReadableBase`](internal-8.ReadableBase.md) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[resume](../interfaces/internal-8.ReadableStream.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:257 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadableBase`](internal-8.ReadableBase.md) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding to use. | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[setEncoding](../interfaces/internal-8.ReadableStream.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:216 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadableBase`](internal-8.ReadableBase.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.3.5 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[setMaxListeners](../interfaces/internal-8.ReadableStream.md#setmaxlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[setMaxListeners](internal-8.Stream.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadableBase`](internal-8.ReadableBase.md) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](internal-8.PassThrough.md#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `destination?` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) | Optional specific stream to unpipe | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[unpipe](../interfaces/internal-8.ReadableStream.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:301 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](internal-8.PassThrough.md#push), `stream.unshift(chunk)` will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if `readable.unshift()` is called during a +read (i.e. from within a [_read](internal-8.PassThrough.md#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](internal-8.PassThrough.md#push) will reset the reading state appropriately, +however it is best to simply avoid calling `readable.unshift()` while in the +process of performing a read. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. | + +#### Returns + +`void` + +**`Since`** + +v0.9.11 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[unshift](../interfaces/internal-8.ReadableStream.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:367 + +___ + +### wrap + +▸ **wrap**(`stream`): [`ReadableBase`](internal-8.ReadableBase.md) + +Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more +information.) + +When using an older Node.js library that emits `'data'` events and has a [pause](internal-8.PassThrough.md#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` +stream that uses +the old stream as its data source. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | An "old style" readable stream | + +#### Returns + +[`ReadableBase`](internal-8.ReadableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[ReadableStream](../interfaces/internal-8.ReadableStream.md).[wrap](../interfaces/internal-8.ReadableStream.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:393 + +___ + +### from + +▸ `Static` **from**(`iterable`, `options?`): [`Readable`](internal-8.Readable.md) + +A utility method for creating Readable Streams out of iterators. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `iterable` | [`Iterable`](../interfaces/internal-8.Iterable.md)<`any`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> | +| `options?` | [`ReadableOptions`](../interfaces/internal-8.internal-2.ReadableOptions.md) | + +#### Returns + +[`Readable`](internal-8.Readable.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:40 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[getEventListeners](internal-8.Stream.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v16.8.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:45 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Stream](internal-8.Stream.md).[listenerCount](internal-8.Stream.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[on](internal-8.Stream.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[setMaxListeners](internal-8.Stream.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md new file mode 100644 index 0000000000..ef801b3f6e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnItem.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnItem + +[internal](../modules/internal-8.md).ReturnItem + +## Properties + +### item\_id + +• **item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:171 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:174 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:172 + +___ + +### reason\_id + +• `Optional` **reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:173 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md new file mode 100644 index 0000000000..b0d0b6f694 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-1.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnShipping + +[internal](../modules/internal-8.md).ReturnShipping + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:177 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:178 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md new file mode 100644 index 0000000000..584504394d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-2.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnShipping + +[internal](../modules/internal-8.md).ReturnShipping + +## Properties + +### option\_id + +• `Optional` **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:145 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:146 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md new file mode 100644 index 0000000000..81cab6830e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping-3.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnShipping + +[internal](../modules/internal-8.md).ReturnShipping + +## Properties + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md new file mode 100644 index 0000000000..2587e86151 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ReturnShipping.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnShipping + +[internal](../modules/internal-8.md).ReturnShipping + +## Properties + +### option\_id + +• `Optional` **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:208 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:209 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md new file mode 100644 index 0000000000..d66f6e09cd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-1.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethod + +[internal](../modules/internal-8.md).ShippingMethod + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:215 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:212 + +___ + +### option\_id + +• `Optional` **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:213 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:214 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md new file mode 100644 index 0000000000..ca44b6d211 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-2.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethod + +[internal](../modules/internal-8.md).ShippingMethod + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:173 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:170 + +___ + +### option\_id + +• `Optional` **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:171 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:172 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md new file mode 100644 index 0000000000..c69ae4eb1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod-3.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingMethod + +[internal](../modules/internal-8.md).ShippingMethod + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:154 + +___ + +### items + +• `Optional` **items**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:155 + +___ + +### price + +• `Optional` **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:153 + +___ + +### profile\_id + +• `Optional` **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:152 + +___ + +### provider\_id + +• `Optional` **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:151 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md index ea3a68a695..862c994c64 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.ShippingMethod.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: ShippingMethod [internal](../modules/internal-8.md).ShippingMethod @@ -6,11 +10,11 @@ ### data -• `Optional` **data**: `Record`<`string`, `unknown`\> +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:189 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:198 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:188 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:197 ___ @@ -30,4 +34,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:190 +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:199 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md b/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md new file mode 100644 index 0000000000..e63c32151f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress-1.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StockLocationAddress + +[internal](../modules/internal-8.md).StockLocationAddress + +## Properties + +### address\_1 + +• **address\_1**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:71 + +___ + +### address\_2 + +• `Optional` **address\_2**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:72 + +___ + +### city + +• `Optional` **city**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:74 + +___ + +### company + +• `Optional` **company**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:73 + +___ + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:75 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:76 + +___ + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:77 + +___ + +### province + +• `Optional` **province**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md b/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md new file mode 100644 index 0000000000..a34380e1f7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.StockLocationAddress.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StockLocationAddress + +[internal](../modules/internal-8.md).StockLocationAddress + +**`Schema`** + +AdminPostStockLocationsReqAddress +type: object +required: + - address_1 + - country_code +properties: + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + company: + type: string + description: Stock location address' company + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + description: "The 2 character ISO code for the country." + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + +## Properties + +### address\_1 + +• **address\_1**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:111 + +___ + +### address\_2 + +• `Optional` **address\_2**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:112 + +___ + +### city + +• `Optional` **city**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:114 + +___ + +### company + +• `Optional` **company**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:113 + +___ + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:115 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:116 + +___ + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:117 + +___ + +### province + +• `Optional` **province**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Stream.md b/www/apps/docs/content/references/js-client/classes/internal-8.Stream.md new file mode 100644 index 0000000000..2167a1d25a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Stream.md @@ -0,0 +1,1228 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Stream + +[internal](../modules/internal-8.md).Stream + +The `EventEmitter` class is defined and exposed by the `node:events` module: + +```js +import { EventEmitter } from 'node:events'; +``` + +All `EventEmitter`s emit the event `'newListener'` when new listeners are +added and `'removeListener'` when existing listeners are removed. + +It supports the following option: + +**`Since`** + +v0.1.26 + +## Hierarchy + +- [`internal`](internal-8.internal-5.md) + + ↳ **`Stream`** + + ↳↳ [`ReadableBase`](internal-8.ReadableBase.md) + + ↳↳ [`WritableBase`](internal-8.WritableBase.md) + +## Properties + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[captureRejectionSymbol](internal-8.internal-5.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[captureRejections](internal-8.internal-5.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[internal](internal-8.internal-5.md).[defaultMaxListeners](internal-8.internal-5.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[errorMonitor](internal-8.internal-5.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[internal](internal-8.internal-5.md).[addListener](internal-8.internal-5.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[internal](internal-8.internal-5.md).[emit](internal-8.internal-5.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[eventNames](internal-8.internal-5.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.Stream.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[getMaxListeners](internal-8.internal-5.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[listenerCount](internal-8.internal-5.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[internal](internal-8.internal-5.md).[listeners](internal-8.internal-5.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[off](internal-8.internal-5.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[internal](internal-8.internal-5.md).[on](internal-8.internal-5.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[once](internal-8.internal-5.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[internal](internal-8.internal-5.md).[pipe](internal-8.internal-5.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[prependListener](internal-8.internal-5.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[prependOnceListener](internal-8.internal-5.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[rawListeners](internal-8.internal-5.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Stream`](internal-8.Stream.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[internal](internal-8.internal-5.md).[removeAllListeners](internal-8.internal-5.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`Stream`](internal-8.Stream.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[internal](internal-8.internal-5.md).[removeListener](internal-8.internal-5.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Stream`](internal-8.Stream.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`Stream`](internal-8.Stream.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[internal](internal-8.internal-5.md).[setMaxListeners](internal-8.internal-5.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[getEventListeners](internal-8.internal-5.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[internal](internal-8.internal-5.md).[listenerCount](internal-8.internal-5.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[on](internal-8.internal-5.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[once](internal-8.internal-5.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[internal](internal-8.internal-5.md).[once](internal-8.internal-5.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[internal](internal-8.internal-5.md).[setMaxListeners](internal-8.internal-5.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Tag.md b/www/apps/docs/content/references/js-client/classes/internal-8.Tag.md new file mode 100644 index 0000000000..c05b3338ec --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Tag.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Tag + +[internal](../modules/internal-8.md).Tag + +## Properties + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:188 + +___ + +### value + +• `Optional` **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:189 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.Transform.md b/www/apps/docs/content/references/js-client/classes/internal-8.Transform.md new file mode 100644 index 0000000000..d863fd579a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.Transform.md @@ -0,0 +1,4450 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Transform + +[internal](../modules/internal-8.md).Transform + +Transform streams are `Duplex` streams where the output is in some way +related to the input. Like all `Duplex` streams, `Transform` streams +implement both the `Readable` and `Writable` interfaces. + +Examples of `Transform` streams include: + +* `zlib streams` +* `crypto streams` + +**`Since`** + +v0.9.4 + +## Hierarchy + +- [`Duplex`](internal-8.Duplex.md) + + ↳ **`Transform`** + + ↳↳ [`PassThrough`](internal-8.PassThrough.md) + +## Properties + +### allowHalfOpen + +• **allowHalfOpen**: `boolean` + +If `false` then the stream will automatically end the writable side when the +readable side ends. Set initially by the `allowHalfOpen` constructor option, +which defaults to `true`. + +This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is +emitted. + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[allowHalfOpen](internal-8.Duplex.md#allowhalfopen) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:881 + +___ + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[closed](internal-8.Duplex.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:870 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `readable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[destroyed](internal-8.Duplex.md#destroyed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:101 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[errored](internal-8.Duplex.md#errored) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:871 + +___ + +### readable + +• **readable**: `boolean` + +Is `true` if it is safe to call `readable.read()`, which means +the stream has not been destroyed or emitted `'error'` or `'end'`. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readable](internal-8.Duplex.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:57 + +___ + +### readableAborted + +• `Readonly` **readableAborted**: `boolean` + +Returns whether the stream was destroyed or errored before emitting `'end'`. + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableAborted](internal-8.Duplex.md#readableaborted) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:51 + +___ + +### readableDidRead + +• `Readonly` **readableDidRead**: `boolean` + +Returns whether `'data'` has been emitted. + +**`Since`** + +v16.7.0, v14.18.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableDidRead](internal-8.Duplex.md#readabledidread) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:63 + +___ + +### readableEncoding + +• `Readonly` **readableEncoding**: ``null`` \| [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method. + +**`Since`** + +v12.7.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableEncoding](internal-8.Duplex.md#readableencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:68 + +___ + +### readableEnded + +• `Readonly` **readableEnded**: `boolean` + +Becomes `true` when `'end'` event is emitted. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableEnded](internal-8.Duplex.md#readableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:73 + +___ + +### readableFlowing + +• `Readonly` **readableFlowing**: ``null`` \| `boolean` + +This property reflects the current state of a `Readable` stream as described +in the `Three states` section. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableFlowing](internal-8.Duplex.md#readableflowing) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:79 + +___ + +### readableHighWaterMark + +• `Readonly` **readableHighWaterMark**: `number` + +Returns the value of `highWaterMark` passed when creating this `Readable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableHighWaterMark](internal-8.Duplex.md#readablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:84 + +___ + +### readableLength + +• `Readonly` **readableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be read. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableLength](internal-8.Duplex.md#readablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:91 + +___ + +### readableObjectMode + +• `Readonly` **readableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Readable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[readableObjectMode](internal-8.Duplex.md#readableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:96 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +Is `true` if it is safe to call `writable.write()`, which means +the stream has not been destroyed, errored, or ended. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writable](internal-8.Duplex.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:862 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +Number of times `writable.uncork()` needs to be +called in order to fully uncork the stream. + +**`Since`** + +v13.2.0, v12.16.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableCorked](internal-8.Duplex.md#writablecorked) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:868 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +Is `true` after `writable.end()` has been called. This property +does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableEnded](internal-8.Duplex.md#writableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:863 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +Is set to `true` immediately before the `'finish'` event is emitted. + +**`Since`** + +v12.6.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableFinished](internal-8.Duplex.md#writablefinished) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:864 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +Return the value of `highWaterMark` passed when creating this `Writable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableHighWaterMark](internal-8.Duplex.md#writablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:865 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableLength](internal-8.Duplex.md#writablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:866 + +___ + +### writableNeedDrain + +• `Readonly` **writableNeedDrain**: `boolean` + +Is `true` if the stream's buffer has been full and stream will emit `'drain'`. + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableNeedDrain](internal-8.Duplex.md#writableneeddrain) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:869 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Writable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[writableObjectMode](internal-8.Duplex.md#writableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:867 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[captureRejectionSymbol](internal-8.Duplex.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[captureRejections](internal-8.Duplex.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[defaultMaxListeners](internal-8.Duplex.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[errorMonitor](internal-8.Duplex.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[[asyncIterator]](internal-8.Duplex.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:475 + +___ + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_construct](internal-8.Duplex.md#_construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:113 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_destroy](internal-8.Duplex.md#_destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:913 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_final](internal-8.Duplex.md#_final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:914 + +___ + +### \_flush + +▸ **_flush**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1076 + +___ + +### \_read + +▸ **_read**(`size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size` | `number` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_read](internal-8.Duplex.md#_read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:114 + +___ + +### \_transform + +▸ **_transform**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1075 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_write](internal-8.Duplex.md#_write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:905 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[_writev](internal-8.Duplex.md#_writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:906 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Event emitter +The defined events on documents including: +1. close +2. data +3. drain +4. end +5. error +6. finish +7. pause +8. pipe +9. readable +10. resume +11. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:959 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:960 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:961 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:962 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:963 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:964 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:965 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:966 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:967 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:968 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:969 + +▸ **addListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[addListener](internal-8.Duplex.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:970 + +___ + +### cork + +▸ **cork**(): `void` + +The `writable.cork()` method forces all written data to be buffered in memory. +The buffered data will be flushed when either the [uncork](internal-8.internal-2.Writable.md#uncork) or [end](internal-8.internal-2.Writable.md#end) methods are called. + +The primary intent of `writable.cork()` is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[cork](internal-8.Duplex.md#cork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:921 + +___ + +### destroy + +▸ **destroy**(`error?`): [`Transform`](internal-8.Transform.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable +stream will release any internal resources and subsequent calls to `push()`will be ignored. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, but instead implement `readable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Error which will be passed as payload in `'error'` event | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v8.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[destroy](internal-8.Duplex.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:407 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:971 + +▸ **emit**(`event`, `chunk`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `chunk` | `any` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:972 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:973 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:974 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:975 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:976 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:977 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:978 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:979 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:980 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:981 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[emit](internal-8.Duplex.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:982 + +___ + +### end + +▸ **end**(`cb?`): [`Transform`](internal-8.Transform.md) + +Calling the `writable.end()` method signals that no more data will be written +to the `Writable`. The optional `chunk` and `encoding` arguments allow one +final additional chunk of data to be written immediately before closing the +stream. + +Calling the [write](internal-8.internal-2.Writable.md#write) method after calling [end](internal-8.internal-2.Writable.md#end) will raise an error. + +```js +// Write 'hello, ' and then end with 'world!'. +const fs = require('node:fs'); +const file = fs.createWriteStream('example.txt'); +file.write('hello, '); +file.end('world!'); +// Writing more now is not allowed! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[end](internal-8.Duplex.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:918 + +▸ **end**(`chunk`, `cb?`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[end](internal-8.Duplex.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:919 + +▸ **end**(`chunk`, `encoding?`, `cb?`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[end](internal-8.Duplex.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:920 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[eventNames](internal-8.Duplex.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.Transform.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[getMaxListeners](internal-8.Duplex.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most +typical cases, there will be no reason to +use this method directly. + +```js +const readable = new stream.Readable(); + +readable.isPaused(); // === false +readable.pause(); +readable.isPaused(); // === true +readable.resume(); +readable.isPaused(); // === false +``` + +#### Returns + +`boolean` + +**`Since`** + +v0.11.14 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[isPaused](internal-8.Duplex.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:274 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[listenerCount](internal-8.Duplex.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[listeners](internal-8.Duplex.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Transform`](internal-8.Transform.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[off](internal-8.Duplex.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:983 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:984 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:985 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:986 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:987 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:988 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:989 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:990 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:991 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:992 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:993 + +▸ **on**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:994 + +___ + +### once + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:995 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:996 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:997 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:998 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:999 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1000 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1001 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1002 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1003 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1004 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1005 + +▸ **once**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1006 + +___ + +### pause + +▸ **pause**(): [`Transform`](internal-8.Transform.md) + +The `readable.pause()` method will cause a stream in flowing mode to stop +emitting `'data'` events, switching out of flowing mode. Any data that +becomes available will remain in the internal buffer. + +```js +const readable = getReadableStreamSomehow(); +readable.on('data', (chunk) => { + console.log(`Received ${chunk.length} bytes of data.`); + readable.pause(); + console.log('There will be no additional data for 1 second.'); + setTimeout(() => { + console.log('Now data will start flowing again.'); + readable.resume(); + }, 1000); +}); +``` + +The `readable.pause()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[pause](internal-8.Duplex.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:238 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[pipe](internal-8.Duplex.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1007 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1008 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1009 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1010 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1011 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1012 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1013 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1014 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1015 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1016 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1017 + +▸ **prependListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependListener](internal-8.Duplex.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1018 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1019 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1020 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1021 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1022 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1023 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1024 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1025 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1026 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1027 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1028 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1029 + +▸ **prependOnceListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[prependOnceListener](internal-8.Duplex.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1030 + +___ + +### push + +▸ **push**(`chunk`, `encoding?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[push](internal-8.Duplex.md#push) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:394 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[rawListeners](internal-8.Duplex.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `any` + +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been +specified using the `readable.setEncoding()` method or the stream is operating +in object mode. + +The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which +case all of the data remaining in the internal +buffer will be returned. + +If the `size` argument is not specified, all of the data contained in the +internal buffer will be returned. + +The `size` argument must be less than or equal to 1 GiB. + +The `readable.read()` method should only be called on `Readable` streams +operating in paused mode. In flowing mode, `readable.read()` is called +automatically until the internal buffer is fully drained. + +```js +const readable = getReadableStreamSomehow(); + +// 'readable' may be triggered multiple times as data is buffered in +readable.on('readable', () => { + let chunk; + console.log('Stream is readable (new data received in buffer)'); + // Use a loop to make sure we read all currently available data + while (null !== (chunk = readable.read())) { + console.log(`Read ${chunk.length} bytes of data...`); + } +}); + +// 'end' will be triggered once when there is no more data available +readable.on('end', () => { + console.log('Reached end of stream.'); +}); +``` + +Each call to `readable.read()` returns a chunk of data, or `null`. The chunks +are not concatenated. A `while` loop is necessary to consume all data +currently in the buffer. When reading a large file `.read()` may return `null`, +having consumed all buffered content so far, but there is still more data to +come not yet buffered. In this case a new `'readable'` event will be emitted +when there is more data in the buffer. Finally the `'end'` event will be +emitted when there is no more data to come. + +Therefore to read a file's whole contents from a `readable`, it is necessary +to collect chunks across multiple `'readable'` events: + +```js +const chunks = []; + +readable.on('readable', () => { + let chunk; + while (null !== (chunk = readable.read())) { + chunks.push(chunk); + } +}); + +readable.on('end', () => { + const content = chunks.join(''); +}); +``` + +A `Readable` stream in object mode will always return a single item from +a call to `readable.read(size)`, regardless of the value of the`size` argument. + +If the `readable.read()` method returns a chunk of data, a `'data'` event will +also be emitted. + +Calling [read](internal-8.PassThrough.md#read) after the `'end'` event has +been emitted will return `null`. No runtime error will be raised. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size?` | `number` | Optional argument to specify how much data to read. | + +#### Returns + +`any` + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[read](internal-8.Duplex.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:191 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Transform`](internal-8.Transform.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeAllListeners](internal-8.Duplex.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1031 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"data"`` | +| `listener` | (`chunk`: `any`) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1032 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1033 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"end"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1034 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1035 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1036 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pause"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1037 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1038 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"readable"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1039 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"resume"`` | +| `listener` | () => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1040 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1041 + +▸ **removeListener**(`event`, `listener`): [`Transform`](internal-8.Transform.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[removeListener](internal-8.Duplex.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1042 + +___ + +### resume + +▸ **resume**(): [`Transform`](internal-8.Transform.md) + +The `readable.resume()` method causes an explicitly paused `Readable` stream to +resume emitting `'data'` events, switching the stream into flowing mode. + +The `readable.resume()` method can be used to fully consume the data from a +stream without actually processing any of that data: + +```js +getReadableStreamSomehow() + .resume() + .on('end', () => { + console.log('Reached the end, but did not read anything.'); + }); +``` + +The `readable.resume()` method has no effect if there is a `'readable'`event listener. + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[resume](internal-8.Duplex.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:257 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Transform`](internal-8.Transform.md) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The new default encoding | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.11.15 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[setDefaultEncoding](internal-8.Duplex.md#setdefaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:917 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`Transform`](internal-8.Transform.md) + +The `readable.setEncoding()` method sets the character encoding for +data read from the `Readable` stream. + +By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data +to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the +output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal +string format. + +The `Readable` stream will properly handle multi-byte characters delivered +through the stream that would otherwise become improperly decoded if simply +pulled from the stream as `Buffer` objects. + +```js +const readable = getReadableStreamSomehow(); +readable.setEncoding('utf8'); +readable.on('data', (chunk) => { + assert.equal(typeof chunk, 'string'); + console.log('Got %d characters of string data:', chunk.length); +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding to use. | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[setEncoding](internal-8.Duplex.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:216 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Transform`](internal-8.Transform.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[setMaxListeners](internal-8.Duplex.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](internal-8.internal-2.Writable.md#cork) was called. + +When using `writable.cork()` and `writable.uncork()` to manage the buffering +of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[uncork](internal-8.Duplex.md#uncork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:922 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`Transform`](internal-8.Transform.md) + +The `readable.unpipe()` method detaches a `Writable` stream previously attached +using the [pipe](internal-8.PassThrough.md#pipe) method. + +If the `destination` is not specified, then _all_ pipes are detached. + +If the `destination` is specified, but no pipe is set up for it, then +the method does nothing. + +```js +const fs = require('node:fs'); +const readable = getReadableStreamSomehow(); +const writable = fs.createWriteStream('file.txt'); +// All the data from readable goes into 'file.txt', +// but only for the first second. +readable.pipe(writable); +setTimeout(() => { + console.log('Stop writing to file.txt.'); + readable.unpipe(writable); + console.log('Manually close the file stream.'); + writable.end(); +}, 1000); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `destination?` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) | Optional specific stream to unpipe | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[unpipe](internal-8.Duplex.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:301 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the +same as `readable.push(null)`, after which no more data can be written. The EOF +signal is put at the end of the buffer and any buffered data will still be +flushed. + +The `readable.unshift()` method pushes a chunk of data back into the internal +buffer. This is useful in certain situations where a stream is being consumed by +code that needs to "un-consume" some amount of data that it has optimistically +pulled out of the source, so that the data can be passed on to some other party. + +The `stream.unshift(chunk)` method cannot be called after the `'end'` event +has been emitted or a runtime error will be thrown. + +Developers using `stream.unshift()` often should consider switching to +use of a `Transform` stream instead. See the `API for stream implementers` section for more information. + +```js +// Pull off a header delimited by \n\n. +// Use unshift() if we get too much. +// Call the callback with (error, header, stream). +const { StringDecoder } = require('node:string_decoder'); +function parseHeader(stream, callback) { + stream.on('error', callback); + stream.on('readable', onReadable); + const decoder = new StringDecoder('utf8'); + let header = ''; + function onReadable() { + let chunk; + while (null !== (chunk = stream.read())) { + const str = decoder.write(chunk); + if (str.includes('\n\n')) { + // Found the header boundary. + const split = str.split(/\n\n/); + header += split.shift(); + const remaining = split.join('\n\n'); + const buf = Buffer.from(remaining, 'utf8'); + stream.removeListener('error', callback); + // Remove the 'readable' listener before unshifting. + stream.removeListener('readable', onReadable); + if (buf.length) + stream.unshift(buf); + // Now the body of the message can be read from the stream. + callback(null, header, stream); + return; + } + // Still reading the header. + header += str; + } + } +} +``` + +Unlike [push](internal-8.PassThrough.md#push), `stream.unshift(chunk)` will not +end the reading process by resetting the internal reading state of the stream. +This can cause unexpected results if `readable.unshift()` is called during a +read (i.e. from within a [_read](internal-8.PassThrough.md#_read) implementation on a +custom stream). Following the call to `readable.unshift()` with an immediate [push](internal-8.PassThrough.md#push) will reset the reading state appropriately, +however it is best to simply avoid calling `readable.unshift()` while in the +process of performing a read. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode streams, `chunk` may be any JavaScript value. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`. | + +#### Returns + +`void` + +**`Since`** + +v0.9.11 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[unshift](internal-8.Duplex.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:367 + +___ + +### wrap + +▸ **wrap**(`stream`): [`Transform`](internal-8.Transform.md) + +Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more +information.) + +When using an older Node.js library that emits `'data'` events and has a [pause](internal-8.PassThrough.md#pause) method that is advisory only, the`readable.wrap()` method can be used to create a `Readable` +stream that uses +the old stream as its data source. + +It will rarely be necessary to use `readable.wrap()` but the method has been +provided as a convenience for interacting with older Node.js applications and +libraries. + +```js +const { OldReader } = require('./old-api-module.js'); +const { Readable } = require('node:stream'); +const oreader = new OldReader(); +const myReader = new Readable().wrap(oreader); + +myReader.on('readable', () => { + myReader.read(); // etc. +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | An "old style" readable stream | + +#### Returns + +[`Transform`](internal-8.Transform.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[wrap](internal-8.Duplex.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:393 + +___ + +### write + +▸ **write**(`chunk`, `encoding?`, `cb?`): `boolean` + +The `writable.write()` method writes some data to the stream, and calls the +supplied `callback` once the data has been fully handled. If an error +occurs, the `callback` will be called with the error as its +first argument. The `callback` is called asynchronously and before `'error'` is +emitted. + +The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. +If `false` is returned, further attempts to write data to the stream should +stop until the `'drain'` event is emitted. + +While a stream is not draining, calls to `write()` will buffer `chunk`, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the `'drain'` event will be emitted. +Once `write()` returns false, do not write more chunks +until the `'drain'` event is emitted. While calling `write()` on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability. + +Writing data while the stream is not draining is particularly +problematic for a `Transform`, because the `Transform` streams are paused +by default until they are piped or a `'data'` or `'readable'` event handler +is added. + +If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a `Readable` and use [pipe](internal-8.PassThrough.md#pipe). However, if calling `write()` is preferred, it is +possible to respect backpressure and avoid memory issues using the `'drain'` event: + +```js +function write(data, cb) { + if (!stream.write(data)) { + stream.once('drain', cb); + } else { + process.nextTick(cb); + } +} + +// Wait for cb to be called before doing any other write. +write('hello', () => { + console.log('Write completed, do more writes now.'); +}); +``` + +A `Writable` stream in object mode will always ignore the `encoding` argument. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | Callback for when this chunk of data is flushed. | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | - | + +#### Returns + +`boolean` + +`false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + +**`Since`** + +v0.9.4 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[write](internal-8.Duplex.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:915 + +▸ **write**(`chunk`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[write](internal-8.Duplex.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:916 + +___ + +### from + +▸ `Static` **from**(`src`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating duplex streams. + +- `Stream` converts writable stream into writable `Duplex` and readable stream + to `Duplex`. +- `Blob` converts into readable `Duplex`. +- `string` converts into readable `Duplex`. +- `ArrayBuffer` converts into readable `Duplex`. +- `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`. +- `AsyncGeneratorFunction` converts into a readable/writable transform + `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield + `null`. +- `AsyncFunction` converts into a writable `Duplex`. Must return + either `null` or `undefined` +- `Object ({ writable, readable })` converts `readable` and + `writable` into `Stream` and then combines them into `Duplex` where the + `Duplex` will write to the `writable` and read from the `readable`. +- `Promise` converts into readable `Duplex`. Value `null` is ignored. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `src` | `string` \| [`Object`](../modules/internal-8.md#object) \| `Promise`<`any`\> \| `ArrayBuffer` \| [`Stream`](internal-8.Stream.md) \| [`Blob`](internal-8.Blob.md) \| [`Iterable`](../interfaces/internal-8.Iterable.md)<`any`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> \| [`AsyncGeneratorFunction`](../interfaces/internal-8.AsyncGeneratorFunction.md) | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[from](internal-8.Duplex.md#from) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:904 + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`duplexStream`, `options?`): [`Duplex`](internal-8.Duplex.md) + +A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `duplexStream` | `Object` | +| `duplexStream.readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `duplexStream.writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | +| `options?` | [`Pick`](../modules/internal-1.md#pick)<[`DuplexOptions`](../interfaces/internal-8.DuplexOptions.md), ``"signal"`` \| ``"allowHalfOpen"`` \| ``"decodeStrings"`` \| ``"encoding"`` \| ``"highWaterMark"`` \| ``"objectMode"``\> | + +#### Returns + +[`Duplex`](internal-8.Duplex.md) + +**`Since`** + +v17.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[fromWeb](internal-8.Duplex.md#fromweb) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:937 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[getEventListeners](internal-8.Duplex.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### isDisturbed + +▸ `Static` **isDisturbed**(`stream`): `boolean` + +Returns whether the stream has been read from or cancelled. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v16.8.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[isDisturbed](internal-8.Duplex.md#isdisturbed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:45 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[listenerCount](internal-8.Duplex.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[on](internal-8.Duplex.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[once](internal-8.Duplex.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[setMaxListeners](internal-8.Duplex.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamDuplex`): `Object` + +A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streamDuplex` | [`Duplex`](internal-8.Duplex.md) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `readable` | [`ReadableStream`](../modules/internal-8.md#readablestream)<`any`\> | +| `writable` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | + +**`Since`** + +v17.0.0 + +#### Inherited from + +[Duplex](internal-8.Duplex.md).[toWeb](internal-8.Duplex.md#toweb) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:928 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md b/www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md new file mode 100644 index 0000000000..cd63c25796 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.WritableBase.md @@ -0,0 +1,2964 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: WritableBase + +[internal](../modules/internal-8.md).WritableBase + +The `EventEmitter` class is defined and exposed by the `node:events` module: + +```js +import { EventEmitter } from 'node:events'; +``` + +All `EventEmitter`s emit the event `'newListener'` when new listeners are +added and `'removeListener'` when existing listeners are removed. + +It supports the following option: + +**`Since`** + +v0.1.26 + +## Hierarchy + +- [`Stream`](internal-8.Stream.md) + + ↳ **`WritableBase`** + + ↳↳ [`Writable`](internal-8.internal-2.Writable.md) + +## Implements + +- [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +## Implemented by + +- [`Duplex`](internal-8.Duplex.md) + +## Properties + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:528 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `writable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:523 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:533 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +Is `true` if it is safe to call `writable.write()`, which means +the stream has not been destroyed, errored, or ended. + +**`Since`** + +v11.4.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[writable](../interfaces/internal-8.WritableStream.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:484 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +Number of times `writable.uncork()` needs to be +called in order to fully uncork the stream. + +**`Since`** + +v13.2.0, v12.16.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:518 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +Is `true` after `writable.end()` has been called. This property +does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + +**`Since`** + +v12.9.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:490 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +Is set to `true` immediately before the `'finish'` event is emitted. + +**`Since`** + +v12.6.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:495 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +Return the value of `highWaterMark` passed when creating this `Writable`. + +**`Since`** + +v9.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:500 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:507 + +___ + +### writableNeedDrain + +• `Readonly` **writableNeedDrain**: `boolean` + +Is `true` if the stream's buffer has been full and stream will emit `'drain'`. + +**`Since`** + +v15.2.0, v14.17.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:538 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Writable` stream. + +**`Since`** + +v12.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:512 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[captureRejectionSymbol](internal-8.Stream.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[captureRejections](internal-8.Stream.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[Stream](internal-8.Stream.md).[defaultMaxListeners](internal-8.Stream.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[errorMonitor](internal-8.Stream.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:548 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:549 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:550 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:540 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:541 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Event emitter +The defined events on documents including: +1. close +2. drain +3. error +4. finish +5. pipe +6. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[addListener](../interfaces/internal-8.WritableStream.md#addlistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[addListener](internal-8.Stream.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:716 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:717 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:718 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:719 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:720 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:721 + +▸ **addListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.addListener + +#### Overrides + +Stream.addListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:722 + +___ + +### cork + +▸ **cork**(): `void` + +The `writable.cork()` method forces all written data to be buffered in memory. +The buffered data will be flushed when either the [uncork](internal-8.internal-2.Writable.md#uncork) or [end](internal-8.internal-2.Writable.md#end) methods are called. + +The primary intent of `writable.cork()` is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:654 + +___ + +### destroy + +▸ **destroy**(`error?`): [`WritableBase`](internal-8.WritableBase.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable +stream has ended and subsequent calls to `write()` or `end()` will result in +an `ERR_STREAM_DESTROYED` error. +This is a destructive and immediate way to destroy a stream. Previous calls to`write()` may not have drained, and may trigger an `ERR_STREAM_DESTROYED` error. +Use `end()` instead of destroy if data should flush before close, or wait for +the `'drain'` event before destroying the stream. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, +but instead implement `writable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Optional, an error to emit with `'error'` event. | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v8.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:705 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[emit](../interfaces/internal-8.WritableStream.md#emit) + +#### Overrides + +[Stream](internal-8.Stream.md).[emit](internal-8.Stream.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:723 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:724 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:725 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:726 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:727 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:728 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Implementation of + +NodeJS.WritableStream.emit + +#### Overrides + +Stream.emit + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:729 + +___ + +### end + +▸ **end**(`cb?`): [`WritableBase`](internal-8.WritableBase.md) + +Calling the `writable.end()` method signals that no more data will be written +to the `Writable`. The optional `chunk` and `encoding` arguments allow one +final additional chunk of data to be written immediately before closing the +stream. + +Calling the [write](internal-8.internal-2.Writable.md#write) method after calling [end](internal-8.internal-2.Writable.md#end) will raise an error. + +```js +// Write 'hello, ' and then end with 'world!'. +const fs = require('node:fs'); +const file = fs.createWriteStream('example.txt'); +file.write('hello, '); +file.end('world!'); +// Writing more now is not allowed! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.9.4 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[end](../interfaces/internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:637 + +▸ **end**(`chunk`, `cb?`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[end](../interfaces/internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:638 + +▸ **end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[end](../interfaces/internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:639 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[eventNames](../interfaces/internal-8.WritableStream.md#eventnames) + +#### Inherited from + +[Stream](internal-8.Stream.md).[eventNames](internal-8.Stream.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.WritableBase.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[getMaxListeners](../interfaces/internal-8.WritableStream.md#getmaxlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[getMaxListeners](internal-8.Stream.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[listenerCount](../interfaces/internal-8.WritableStream.md#listenercount) + +#### Inherited from + +[Stream](internal-8.Stream.md).[listenerCount](internal-8.Stream.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[listeners](../interfaces/internal-8.WritableStream.md#listeners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[listeners](internal-8.Stream.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v10.0.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[off](../interfaces/internal-8.WritableStream.md#off) + +#### Inherited from + +[Stream](internal-8.Stream.md).[off](internal-8.Stream.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.1.101 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[on](../interfaces/internal-8.WritableStream.md#on) + +#### Overrides + +[Stream](internal-8.Stream.md).[on](internal-8.Stream.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:730 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:731 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:732 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:733 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:734 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:735 + +▸ **on**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.on + +#### Overrides + +Stream.on + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:736 + +___ + +### once + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.3.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[once](../interfaces/internal-8.WritableStream.md#once) + +#### Overrides + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:737 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:738 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:739 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:740 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:741 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:742 + +▸ **once**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.once + +#### Overrides + +Stream.once + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:743 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[Stream](internal-8.Stream.md).[pipe](internal-8.Stream.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[prependListener](../interfaces/internal-8.WritableStream.md#prependlistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[prependListener](internal-8.Stream.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:744 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:745 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:746 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:747 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:748 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:749 + +▸ **prependListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependListener + +#### Overrides + +Stream.prependListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:750 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v6.0.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[prependOnceListener](../interfaces/internal-8.WritableStream.md#prependoncelistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[prependOnceListener](internal-8.Stream.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:751 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:752 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:753 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:754 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:755 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:756 + +▸ **prependOnceListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.prependOnceListener + +#### Overrides + +Stream.prependOnceListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:757 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[rawListeners](../interfaces/internal-8.WritableStream.md#rawlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[rawListeners](internal-8.Stream.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`WritableBase`](internal-8.WritableBase.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[removeAllListeners](../interfaces/internal-8.WritableStream.md#removealllisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[removeAllListeners](internal-8.Stream.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.1.26 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[removeListener](../interfaces/internal-8.WritableStream.md#removelistener) + +#### Overrides + +[Stream](internal-8.Stream.md).[removeListener](internal-8.Stream.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:758 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:759 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:760 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:761 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:762 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:763 + +▸ **removeListener**(`event`, `listener`): [`WritableBase`](internal-8.WritableBase.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +#### Implementation of + +NodeJS.WritableStream.removeListener + +#### Overrides + +Stream.removeListener + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:764 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`WritableBase`](internal-8.WritableBase.md) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The new default encoding | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:614 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`WritableBase`](internal-8.WritableBase.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`WritableBase`](internal-8.WritableBase.md) + +**`Since`** + +v0.3.5 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[setMaxListeners](../interfaces/internal-8.WritableStream.md#setmaxlisteners) + +#### Inherited from + +[Stream](internal-8.Stream.md).[setMaxListeners](internal-8.Stream.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](internal-8.internal-2.Writable.md#cork) was called. + +When using `writable.cork()` and `writable.uncork()` to manage the buffering +of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:688 + +___ + +### write + +▸ **write**(`chunk`, `callback?`): `boolean` + +The `writable.write()` method writes some data to the stream, and calls the +supplied `callback` once the data has been fully handled. If an error +occurs, the `callback` will be called with the error as its +first argument. The `callback` is called asynchronously and before `'error'` is +emitted. + +The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. +If `false` is returned, further attempts to write data to the stream should +stop until the `'drain'` event is emitted. + +While a stream is not draining, calls to `write()` will buffer `chunk`, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the `'drain'` event will be emitted. +Once `write()` returns false, do not write more chunks +until the `'drain'` event is emitted. While calling `write()` on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability. + +Writing data while the stream is not draining is particularly +problematic for a `Transform`, because the `Transform` streams are paused +by default until they are piped or a `'data'` or `'readable'` event handler +is added. + +If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a `Readable` and use [pipe](internal-8.PassThrough.md#pipe). However, if calling `write()` is preferred, it is +possible to respect backpressure and avoid memory issues using the `'drain'` event: + +```js +function write(data, cb) { + if (!stream.write(data)) { + stream.once('drain', cb); + } else { + process.nextTick(cb); + } +} + +// Wait for cb to be called before doing any other write. +write('hello', () => { + console.log('Write completed, do more writes now.'); +}); +``` + +A `Writable` stream in object mode will always ignore the `encoding` argument. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. | +| `callback?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | Callback for when this chunk of data is flushed. | + +#### Returns + +`boolean` + +`false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + +**`Since`** + +v0.9.4 + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[write](../interfaces/internal-8.WritableStream.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:607 + +▸ **write**(`chunk`, `encoding`, `callback?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Implementation of + +[WritableStream](../interfaces/internal-8.WritableStream.md).[write](../interfaces/internal-8.WritableStream.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:608 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[getEventListeners](internal-8.Stream.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[Stream](internal-8.Stream.md).[listenerCount](internal-8.Stream.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[on](internal-8.Stream.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[Stream](internal-8.Stream.md).[once](internal-8.Stream.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[Stream](internal-8.Stream.md).[setMaxListeners](internal-8.Stream.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md new file mode 100644 index 0000000000..12b43c5ef3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal-2.Writable.md @@ -0,0 +1,2844 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Writable + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).Writable + +**`Since`** + +v0.9.4 + +## Hierarchy + +- [`WritableBase`](internal-8.WritableBase.md) + + ↳ **`Writable`** + +## Properties + +### closed + +• `Readonly` **closed**: `boolean` + +Is `true` after `'close'` has been emitted. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[closed](internal-8.WritableBase.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:528 + +___ + +### destroyed + +• **destroyed**: `boolean` + +Is `true` after `writable.destroy()` has been called. + +**`Since`** + +v8.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[destroyed](internal-8.WritableBase.md#destroyed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:523 + +___ + +### errored + +• `Readonly` **errored**: ``null`` \| [`Error`](../modules/internal-8.md#error) + +Returns error if the stream has been destroyed with an error. + +**`Since`** + +v18.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[errored](internal-8.WritableBase.md#errored) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:533 + +___ + +### writable + +• `Readonly` **writable**: `boolean` + +Is `true` if it is safe to call `writable.write()`, which means +the stream has not been destroyed, errored, or ended. + +**`Since`** + +v11.4.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writable](internal-8.WritableBase.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:484 + +___ + +### writableCorked + +• `Readonly` **writableCorked**: `number` + +Number of times `writable.uncork()` needs to be +called in order to fully uncork the stream. + +**`Since`** + +v13.2.0, v12.16.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableCorked](internal-8.WritableBase.md#writablecorked) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:518 + +___ + +### writableEnded + +• `Readonly` **writableEnded**: `boolean` + +Is `true` after `writable.end()` has been called. This property +does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead. + +**`Since`** + +v12.9.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableEnded](internal-8.WritableBase.md#writableended) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:490 + +___ + +### writableFinished + +• `Readonly` **writableFinished**: `boolean` + +Is set to `true` immediately before the `'finish'` event is emitted. + +**`Since`** + +v12.6.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableFinished](internal-8.WritableBase.md#writablefinished) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:495 + +___ + +### writableHighWaterMark + +• `Readonly` **writableHighWaterMark**: `number` + +Return the value of `highWaterMark` passed when creating this `Writable`. + +**`Since`** + +v9.3.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableHighWaterMark](internal-8.WritableBase.md#writablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:500 + +___ + +### writableLength + +• `Readonly` **writableLength**: `number` + +This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the `highWaterMark`. + +**`Since`** + +v9.4.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableLength](internal-8.WritableBase.md#writablelength) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:507 + +___ + +### writableNeedDrain + +• `Readonly` **writableNeedDrain**: `boolean` + +Is `true` if the stream's buffer has been full and stream will emit `'drain'`. + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableNeedDrain](internal-8.WritableBase.md#writableneeddrain) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:538 + +___ + +### writableObjectMode + +• `Readonly` **writableObjectMode**: `boolean` + +Getter for the property `objectMode` of a given `Writable` stream. + +**`Since`** + +v12.3.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[writableObjectMode](internal-8.WritableBase.md#writableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:512 + +___ + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[captureRejectionSymbol](internal-8.WritableBase.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[captureRejections](internal-8.WritableBase.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[defaultMaxListeners](internal-8.WritableBase.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[errorMonitor](internal-8.WritableBase.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### \_construct + +▸ `Optional` **_construct**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[_construct](internal-8.WritableBase.md#_construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:548 + +___ + +### \_destroy + +▸ **_destroy**(`error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[_destroy](internal-8.WritableBase.md#_destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:549 + +___ + +### \_final + +▸ **_final**(`callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[_final](internal-8.WritableBase.md#_final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:550 + +___ + +### \_write + +▸ **_write**(`chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[_write](internal-8.WritableBase.md#_write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:540 + +___ + +### \_writev + +▸ `Optional` **_writev**(`chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[_writev](internal-8.WritableBase.md#_writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:541 + +___ + +### addListener + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Event emitter +The defined events on documents including: +1. close +2. drain +3. error +4. finish +5. pipe +6. unpipe + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:716 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:717 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:718 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:719 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:720 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:721 + +▸ **addListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[addListener](internal-8.WritableBase.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:722 + +___ + +### cork + +▸ **cork**(): `void` + +The `writable.cork()` method forces all written data to be buffered in memory. +The buffered data will be flushed when either the [uncork](internal-8.internal-2.Writable.md#uncork) or [end](internal-8.internal-2.Writable.md#end) methods are called. + +The primary intent of `writable.cork()` is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them +all to `writable._writev()`, if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput. + +See also: `writable.uncork()`, `writable._writev()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[cork](internal-8.WritableBase.md#cork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:654 + +___ + +### destroy + +▸ **destroy**(`error?`): [`Writable`](internal-8.internal-2.Writable.md) + +Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable +stream has ended and subsequent calls to `write()` or `end()` will result in +an `ERR_STREAM_DESTROYED` error. +This is a destructive and immediate way to destroy a stream. Previous calls to`write()` may not have drained, and may trigger an `ERR_STREAM_DESTROYED` error. +Use `end()` instead of destroy if data should flush before close, or wait for +the `'drain'` event before destroying the stream. + +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. + +Implementors should not override this method, +but instead implement `writable._destroy()`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `error?` | [`Error`](../modules/internal-8.md#error) | Optional, an error to emit with `'error'` event. | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v8.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[destroy](internal-8.WritableBase.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:705 + +___ + +### emit + +▸ **emit**(`event`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:723 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:724 + +▸ **emit**(`event`, `err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `err` | [`Error`](../modules/internal-8.md#error) | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:725 + +▸ **emit**(`event`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:726 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:727 + +▸ **emit**(`event`, `src`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `src` | [`Readable`](internal-8.Readable.md) | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:728 + +▸ **emit**(`event`, `...args`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[emit](internal-8.WritableBase.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:729 + +___ + +### end + +▸ **end**(`cb?`): [`Writable`](internal-8.internal-2.Writable.md) + +Calling the `writable.end()` method signals that no more data will be written +to the `Writable`. The optional `chunk` and `encoding` arguments allow one +final additional chunk of data to be written immediately before closing the +stream. + +Calling the [write](internal-8.internal-2.Writable.md#write) method after calling [end](internal-8.internal-2.Writable.md#end) will raise an error. + +```js +// Write 'hello, ' and then end with 'world!'. +const fs = require('node:fs'); +const file = fs.createWriteStream('example.txt'); +file.write('hello, '); +file.end('world!'); +// Writing more now is not allowed! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.9.4 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:637 + +▸ **end**(`chunk`, `cb?`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `cb?` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:638 + +▸ **end**(`chunk`, `encoding`, `cb?`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[end](internal-8.WritableBase.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:639 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[eventNames](internal-8.WritableBase.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.internal-2.Writable.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[getMaxListeners](internal-8.WritableBase.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[listenerCount](internal-8.WritableBase.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[listeners](internal-8.WritableBase.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[off](internal-8.WritableBase.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:730 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:731 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:732 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:733 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:734 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:735 + +▸ **on**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:736 + +___ + +### once + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:737 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:738 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:739 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:740 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:741 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:742 + +▸ **once**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:743 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[pipe](internal-8.WritableBase.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:744 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:745 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:746 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:747 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:748 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:749 + +▸ **prependListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependListener](internal-8.WritableBase.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:750 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | ``"close"`` | The name of the event. | +| `listener` | () => `void` | The callback function | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:751 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:752 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:753 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:754 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:755 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:756 + +▸ **prependOnceListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[prependOnceListener](internal-8.WritableBase.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:757 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[rawListeners](internal-8.WritableBase.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`Writable`](internal-8.internal-2.Writable.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeAllListeners](internal-8.WritableBase.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"close"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:758 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"drain"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:759 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"error"`` | +| `listener` | (`err`: [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:760 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"finish"`` | +| `listener` | () => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:761 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"pipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:762 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | ``"unpipe"`` | +| `listener` | (`src`: [`Readable`](internal-8.Readable.md)) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:763 + +▸ **removeListener**(`event`, `listener`): [`Writable`](internal-8.internal-2.Writable.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[removeListener](internal-8.WritableBase.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:764 + +___ + +### setDefaultEncoding + +▸ **setDefaultEncoding**(`encoding`): [`Writable`](internal-8.internal-2.Writable.md) + +The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The new default encoding | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.11.15 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[setDefaultEncoding](internal-8.WritableBase.md#setdefaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:614 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`Writable`](internal-8.internal-2.Writable.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[setMaxListeners](internal-8.WritableBase.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### uncork + +▸ **uncork**(): `void` + +The `writable.uncork()` method flushes all data buffered since [cork](internal-8.internal-2.Writable.md#cork) was called. + +When using `writable.cork()` and `writable.uncork()` to manage the buffering +of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event +loop phase. + +```js +stream.cork(); +stream.write('some '); +stream.write('data '); +process.nextTick(() => stream.uncork()); +``` + +If the `writable.cork()` method is called multiple times on a stream, the +same number of calls to `writable.uncork()` must be called to flush the buffered +data. + +```js +stream.cork(); +stream.write('some '); +stream.cork(); +stream.write('data '); +process.nextTick(() => { + stream.uncork(); + // The data will not be flushed until uncork() is called a second time. + stream.uncork(); +}); +``` + +See also: `writable.cork()`. + +#### Returns + +`void` + +**`Since`** + +v0.11.2 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[uncork](internal-8.WritableBase.md#uncork) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:688 + +___ + +### write + +▸ **write**(`chunk`, `callback?`): `boolean` + +The `writable.write()` method writes some data to the stream, and calls the +supplied `callback` once the data has been fully handled. If an error +occurs, the `callback` will be called with the error as its +first argument. The `callback` is called asynchronously and before `'error'` is +emitted. + +The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`. +If `false` is returned, further attempts to write data to the stream should +stop until the `'drain'` event is emitted. + +While a stream is not draining, calls to `write()` will buffer `chunk`, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the `'drain'` event will be emitted. +Once `write()` returns false, do not write more chunks +until the `'drain'` event is emitted. While calling `write()` on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability. + +Writing data while the stream is not draining is particularly +problematic for a `Transform`, because the `Transform` streams are paused +by default until they are piped or a `'data'` or `'readable'` event handler +is added. + +If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a `Readable` and use [pipe](internal-8.PassThrough.md#pipe). However, if calling `write()` is preferred, it is +possible to respect backpressure and avoid memory issues using the `'drain'` event: + +```js +function write(data, cb) { + if (!stream.write(data)) { + stream.once('drain', cb); + } else { + process.nextTick(cb); + } +} + +// Wait for cb to be called before doing any other write. +write('hello', () => { + console.log('Write completed, do more writes now.'); +}); +``` + +A `Writable` stream in object mode will always ignore the `encoding` argument. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `chunk` | `any` | Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any JavaScript value other than `null`. | +| `callback?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | Callback for when this chunk of data is flushed. | + +#### Returns + +`boolean` + +`false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`. + +**`Since`** + +v0.9.4 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[write](internal-8.WritableBase.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:607 + +▸ **write**(`chunk`, `encoding`, `callback?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback?` | (`error`: `undefined` \| ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[write](internal-8.WritableBase.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:608 + +___ + +### fromWeb + +▸ `Static` **fromWeb**(`writableStream`, `options?`): [`Writable`](internal-8.internal-2.Writable.md) + +A utility method for creating a `Writable` from a web `WritableStream`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `writableStream` | [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> | +| `options?` | [`Pick`](../modules/internal-1.md#pick)<[`WritableOptions`](../interfaces/internal-8.internal-2.WritableOptions.md), ``"signal"`` \| ``"decodeStrings"`` \| ``"highWaterMark"`` \| ``"objectMode"``\> | + +#### Returns + +[`Writable`](internal-8.internal-2.Writable.md) + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:822 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[getEventListeners](internal-8.WritableBase.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[listenerCount](internal-8.WritableBase.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[on](internal-8.WritableBase.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[once](internal-8.WritableBase.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[WritableBase](internal-8.WritableBase.md).[setMaxListeners](internal-8.WritableBase.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 + +___ + +### toWeb + +▸ `Static` **toWeb**(`streamWritable`): [`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> + +A utility method for creating a web `WritableStream` from a `Writable`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streamWritable` | [`Writable`](internal-8.internal-2.Writable.md) | + +#### Returns + +[`WritableStream`](../modules/internal-8.md#writablestream)<`any`\> + +**`Since`** + +v17.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:828 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md new file mode 100644 index 0000000000..95c0b6e72f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal-5.md @@ -0,0 +1,1222 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: internal + +[internal](../modules/internal-8.md).internal + +The `EventEmitter` class is defined and exposed by the `node:events` module: + +```js +import { EventEmitter } from 'node:events'; +``` + +All `EventEmitter`s emit the event `'newListener'` when new listeners are +added and `'removeListener'` when existing listeners are removed. + +It supports the following option: + +**`Since`** + +v0.1.26 + +## Hierarchy + +- [`EventEmitter`](internal-8.EventEmitter-1.md) + + ↳ **`internal`** + + ↳↳ [`Stream`](internal-8.Stream.md) + +## Properties + +### captureRejectionSymbol + +▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](internal-8.PassThrough.md#capturerejectionsymbol) + +Value: `Symbol.for('nodejs.rejection')` + +See how to write a custom `rejection handler`. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[captureRejectionSymbol](internal-8.EventEmitter-1.md#capturerejectionsymbol) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:326 + +___ + +### captureRejections + +▪ `Static` **captureRejections**: `boolean` + +Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type) + +Change the default `captureRejections` option on all new `EventEmitter` objects. + +**`Since`** + +v13.4.0, v12.16.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[captureRejections](internal-8.EventEmitter-1.md#capturerejections) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:333 + +___ + +### defaultMaxListeners + +▪ `Static` **defaultMaxListeners**: `number` + +By default, a maximum of `10` listeners can be registered for any single +event. This limit can be changed for individual `EventEmitter` instances +using the `emitter.setMaxListeners(n)` method. To change the default +for _all_`EventEmitter` instances, the `events.defaultMaxListeners`property can be used. If this value is not a positive number, a `RangeError`is thrown. + +Take caution when setting the `events.defaultMaxListeners` because the +change affects _all_`EventEmitter` instances, including those created before +the change is made. However, calling `emitter.setMaxListeners(n)` still has +precedence over `events.defaultMaxListeners`. + +This is not a hard limit. The `EventEmitter` instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any single`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`methods can be used to +temporarily avoid this warning: + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.setMaxListeners(emitter.getMaxListeners() + 1); +emitter.once('event', () => { + // do stuff + emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0)); +}); +``` + +The `--trace-warnings` command-line flag can be used to display the +stack trace for such warnings. + +The emitted warning can be inspected with `process.on('warning')` and will +have the additional `emitter`, `type`, and `count` properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its `name` property is set to `'MaxListenersExceededWarning'`. + +**`Since`** + +v0.11.2 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[defaultMaxListeners](internal-8.EventEmitter-1.md#defaultmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:370 + +___ + +### errorMonitor + +▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](internal-8.PassThrough.md#errormonitor) + +This symbol shall be used to install a listener for only monitoring `'error'`events. Listeners installed using this symbol are called before the regular`'error'` listeners are called. + +Installing a listener using this symbol does not change the behavior once an`'error'` event is emitted. Therefore, the process will still crash if no +regular `'error'` listener is installed. + +**`Since`** + +v13.6.0, v12.17.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[errorMonitor](internal-8.EventEmitter-1.md#errormonitor) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:319 + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[addListener](internal-8.EventEmitter-1.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[emit](internal-8.EventEmitter-1.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[eventNames](internal-8.EventEmitter-1.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](internal-8.internal-5.md#defaultmaxlisteners). + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[getMaxListeners](internal-8.EventEmitter-1.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[listenerCount](internal-8.EventEmitter-1.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[listeners](internal-8.EventEmitter-1.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[off](internal-8.EventEmitter-1.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[on](internal-8.EventEmitter-1.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[once](internal-8.EventEmitter-1.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:26 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[prependListener](internal-8.EventEmitter-1.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[prependOnceListener](internal-8.EventEmitter-1.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[rawListeners](internal-8.EventEmitter-1.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`internal`](internal-8.internal-5.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[removeAllListeners](internal-8.EventEmitter-1.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`internal`](internal-8.internal-5.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[removeListener](internal-8.EventEmitter-1.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`internal`](internal-8.internal-5.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`internal`](internal-8.internal-5.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[setMaxListeners](internal-8.EventEmitter-1.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### getEventListeners + +▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +For `EventEmitter`s this behaves exactly the same as calling `.listeners` on +the emitter. + +For `EventTarget`s this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes. + +```js +import { getEventListeners, EventEmitter } from 'node:events'; + +{ + const ee = new EventEmitter(); + const listener = () => console.log('Events are fun'); + ee.on('foo', listener); + console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ] +} +{ + const et = new EventTarget(); + const listener = () => console.log('Events are fun'); + et.addEventListener('foo', listener); + console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ] +} +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `name` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v15.2.0, v14.17.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[getEventListeners](internal-8.EventEmitter-1.md#geteventlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:296 + +___ + +### listenerCount + +▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` + +A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. + +```js +import { EventEmitter, listenerCount } from 'node:events'; + +const myEmitter = new EventEmitter(); +myEmitter.on('event', () => {}); +myEmitter.on('event', () => {}); +console.log(listenerCount(myEmitter, 'event')); +// Prints: 2 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | The emitter to query | +| `eventName` | `string` \| `symbol` | The event name | + +#### Returns + +`number` + +**`Since`** + +v0.9.12 + +**`Deprecated`** + +Since v3.2.0 - Use `listenerCount` instead. + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[listenerCount](internal-8.EventEmitter-1.md#listenercount-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:268 + +___ + +### on + +▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +// Emit later on +process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); +}); + +for await (const event of on(ee, 'foo')) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] +} +// Unreachable here +``` + +Returns an `AsyncIterator` that iterates `eventName` events. It will throw +if the `EventEmitter` emits `'error'`. It removes all listeners when +exiting the loop. The `value` returned by each iteration is an array +composed of the emitted event arguments. + +An `AbortSignal` can be used to cancel waiting on events: + +```js +import { on, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ac = new AbortController(); + +(async () => { + const ee = new EventEmitter(); + + // Emit later on + process.nextTick(() => { + ee.emit('foo', 'bar'); + ee.emit('foo', 42); + }); + + for await (const event of on(ee, 'foo', { signal: ac.signal })) { + // The execution of this inner block is synchronous and it + // processes one event at a time (even with await). Do not use + // if concurrent execution is required. + console.log(event); // prints ['bar'] [42] + } + // Unreachable here +})(); + +process.nextTick(() => ac.abort()); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `emitter` | [`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) | - | +| `eventName` | `string` | The name of the event being listened for | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | - | + +#### Returns + +[`AsyncIterableIterator`](../interfaces/internal-8.AsyncIterableIterator.md)<`any`\> + +that iterates `eventName` events emitted by the `emitter` + +**`Since`** + +v13.6.0, v12.16.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[on](internal-8.EventEmitter-1.md#on-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:250 + +___ + +### once + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given +event or that is rejected if the `EventEmitter` emits `'error'` while waiting. +The `Promise` will resolve with an array of all the arguments emitted to the +given event. + +This method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special`'error'` event +semantics and does not listen to the `'error'` event. + +```js +import { once, EventEmitter } from 'node:events'; +import process from 'node:process'; + +const ee = new EventEmitter(); + +process.nextTick(() => { + ee.emit('myevent', 42); +}); + +const [value] = await once(ee, 'myevent'); +console.log(value); + +const err = new Error('kaboom'); +process.nextTick(() => { + ee.emit('error', err); +}); + +try { + await once(ee, 'myevent'); +} catch (err) { + console.error('error happened', err); +} +``` + +The special handling of the `'error'` event is only used when `events.once()`is used to wait for another event. If `events.once()` is used to wait for the +'`error'` event itself, then it is treated as any other kind of event without +special handling: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); + +once(ee, 'error') + .then(([err]) => console.log('ok', err.message)) + .catch((err) => console.error('error', err.message)); + +ee.emit('error', new Error('boom')); + +// Prints: ok boom +``` + +An `AbortSignal` can be used to cancel waiting for the event: + +```js +import { EventEmitter, once } from 'node:events'; + +const ee = new EventEmitter(); +const ac = new AbortController(); + +async function foo(emitter, event, signal) { + try { + await once(emitter, event, { signal }); + console.log('event emitted!'); + } catch (error) { + if (error.name === 'AbortError') { + console.error('Waiting for the event was canceled!'); + } else { + console.error('There was an error', error.message); + } + } +} + +foo(ee, 'foo', ac.signal); +ac.abort(); // Abort waiting for the event +ee.emit('foo'); // Prints: Waiting for the event was canceled! +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_NodeEventTarget`](../interfaces/internal-8._NodeEventTarget.md) | +| `eventName` | `string` \| `symbol` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +**`Since`** + +v11.13.0, v10.16.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[once](internal-8.EventEmitter-1.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:189 + +▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `emitter` | [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md) | +| `eventName` | `string` | +| `options?` | [`StaticEventEmitterOptions`](../interfaces/internal-8.StaticEventEmitterOptions.md) | + +#### Returns + +`Promise`<`any`[]\> + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[once](internal-8.EventEmitter-1.md#once-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:190 + +___ + +### setMaxListeners + +▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` + +```js +import { setMaxListeners, EventEmitter } from 'node:events'; + +const target = new EventTarget(); +const emitter = new EventEmitter(); + +setMaxListeners(5, target, emitter); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `n?` | `number` | A non-negative number. The maximum number of listeners per `EventTarget` event. | +| `...eventTargets` | ([`EventEmitter`](../interfaces/internal-8.EventEmitter-2.md) \| [`_DOMEventTarget`](../interfaces/internal-8._DOMEventTarget.md))[] | - | + +#### Returns + +`void` + +**`Since`** + +v15.4.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-1.md).[setMaxListeners](internal-8.EventEmitter-1.md#setmaxlisteners-1) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:311 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md new file mode 100644 index 0000000000..5b059e1dad --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractBatchJobStrategy.md @@ -0,0 +1,406 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractBatchJobStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractBatchJobStrategy + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractBatchJobStrategy`** + +## Implements + +- [`IBatchJobStrategy`](../interfaces/internal-8.internal.IBatchJobStrategy.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[__configModule__](../interfaces/internal-8.internal.IBatchJobStrategy.md#__configmodule__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[__container__](../interfaces/internal-8.internal.IBatchJobStrategy.md#__container__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[__moduleDeclaration__](../interfaces/internal-8.internal.IBatchJobStrategy.md#__moduledeclaration__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### batchJobService\_ + +• `Protected` `Abstract` **batchJobService\_**: [`BatchJobService`](internal-8.internal.BatchJobService.md) + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:26 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[manager_](../interfaces/internal-8.internal.IBatchJobStrategy.md#manager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[transactionManager_](../interfaces/internal-8.internal.IBatchJobStrategy.md#transactionmanager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### batchType + +▪ `Static` **batchType**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:25 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:24 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Implementation of + +IBatchJobStrategy.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[atomicPhase_](../interfaces/internal-8.internal.IBatchJobStrategy.md#atomicphase_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### buildTemplate + +▸ `Abstract` **buildTemplate**(): `Promise`<`string`\> + +Builds and returns a template file that can be downloaded and filled in + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[buildTemplate](../interfaces/internal-8.internal.IBatchJobStrategy.md#buildtemplate) + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:30 + +___ + +### handleProcessingError + +▸ `Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | +| `err` | `unknown` | +| `result` | `T` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:32 + +___ + +### preProcessBatchJob + +▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> + +Method for pre-processing a batch job + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[preProcessBatchJob](../interfaces/internal-8.internal.IBatchJobStrategy.md#preprocessbatchjob) + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:28 + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +Method for preparing a batch job for processing + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJob` | [`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput) | +| `req` | `Request` | + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[prepareBatchJobForProcessing](../interfaces/internal-8.internal.IBatchJobStrategy.md#preparebatchjobforprocessing) + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:27 + +___ + +### processJob + +▸ `Abstract` **processJob**(`batchJobId`): `Promise`<`void`\> + +Method does the actual processing of the job. Should report back on the progress of the operation. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[processJob](../interfaces/internal-8.internal.IBatchJobStrategy.md#processjob) + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:29 + +___ + +### shouldRetryOnProcessingError + +▸ `Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJob` | [`BatchJob`](internal-2.BatchJob.md) | +| `err` | `unknown` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:31 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[shouldRetryTransaction_](../interfaces/internal-8.internal.IBatchJobStrategy.md#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](internal-8.internal.AbstractBatchJobStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractBatchJobStrategy`](internal-8.internal.AbstractBatchJobStrategy.md) + +#### Implementation of + +[IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md).[withTransaction](../interfaces/internal-8.internal.IBatchJobStrategy.md#withtransaction) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md new file mode 100644 index 0000000000..018675da54 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractCartCompletionStrategy.md @@ -0,0 +1,223 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractCartCompletionStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractCartCompletionStrategy + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractCartCompletionStrategy`** + +## Implements + +- [`ICartCompletionStrategy`](../interfaces/internal-8.internal.ICartCompletionStrategy.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### complete + +▸ `Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/internal-8.internal.md#cartcompletionresponse)\> + +Takes a cart id and completes the cart. This for example takes place when +creating an order or confirming a swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the Cart to complete. | +| `idempotencyKey` | [`IdempotencyKey`](internal-8.internal.IdempotencyKey.md) | the idempotency key for the request | +| `context` | [`RequestContext`](../modules/internal-8.md#requestcontext) | the request context for the completion request | + +#### Returns + +`Promise`<[`CartCompletionResponse`](../modules/internal-8.internal.md#cartcompletionresponse)\> + +the response for the completion request + +#### Implementation of + +[ICartCompletionStrategy](../interfaces/internal-8.internal.ICartCompletionStrategy.md).[complete](../interfaces/internal-8.internal.ICartCompletionStrategy.md#complete) + +#### Defined in + +packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:22 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](internal-8.internal.AbstractCartCompletionStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractCartCompletionStrategy`](internal-8.internal.AbstractCartCompletionStrategy.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md new file mode 100644 index 0000000000..61ba369efe --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFileService.md @@ -0,0 +1,388 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractFileService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractFileService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractFileService`** + +## Implements + +- [`IFileService`](../interfaces/internal-8.internal.IFileService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[__configModule__](../interfaces/internal-8.internal.IFileService.md#__configmodule__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[__container__](../interfaces/internal-8.internal.IFileService.md#__container__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[__moduleDeclaration__](../interfaces/internal-8.internal.IFileService.md#__moduledeclaration__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[manager_](../interfaces/internal-8.internal.IFileService.md#manager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[transactionManager_](../interfaces/internal-8.internal.IFileService.md#transactionmanager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Implementation of + +IFileService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[atomicPhase_](../interfaces/internal-8.internal.IFileService.md#atomicphase_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### delete + +▸ `Abstract` **delete**(`fileData`): `Promise`<`void`\> + +remove file from fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`DeleteFileType`](../modules/internal-8.md#deletefiletype) | Remove file described by record | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[delete](../interfaces/internal-8.internal.IFileService.md#delete) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:43 + +___ + +### getDownloadStream + +▸ `Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/internal-8.ReadableStream.md)\> + +download file from fileservice as stream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`GetUploadedFileType`](../modules/internal-8.md#getuploadedfiletype) | file metadata relevant for fileservice to download the file | + +#### Returns + +`Promise`<[`ReadableStream`](../interfaces/internal-8.ReadableStream.md)\> + +readable stream of the file to download + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[getDownloadStream](../interfaces/internal-8.internal.IFileService.md#getdownloadstream) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:45 + +___ + +### getPresignedDownloadUrl + +▸ `Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> + +Generate a presigned download url to obtain a file + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`GetUploadedFileType`](../modules/internal-8.md#getuploadedfiletype) | file metadata relevant for fileservice to download the file | + +#### Returns + +`Promise`<`string`\> + +presigned url to download the file + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[getPresignedDownloadUrl](../interfaces/internal-8.internal.IFileService.md#getpresigneddownloadurl) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:46 + +___ + +### getUploadStreamDescriptor + +▸ `Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../modules/internal-8.md#fileservicegetuploadstreamresult)\> + +upload file to fileservice from stream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`UploadStreamDescriptorType`](../modules/internal-8.md#uploadstreamdescriptortype) | file metadata relevant for fileservice to create and upload the file | + +#### Returns + +`Promise`<[`FileServiceGetUploadStreamResult`](../modules/internal-8.md#fileservicegetuploadstreamresult)\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[getUploadStreamDescriptor](../interfaces/internal-8.internal.IFileService.md#getuploadstreamdescriptor) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:44 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[shouldRetryTransaction_](../interfaces/internal-8.internal.IFileService.md#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### upload + +▸ `Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +upload file to fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | `File` | Multer file from express multipart/form-data | + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[upload](../interfaces/internal-8.internal.IFileService.md#upload) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:41 + +___ + +### uploadProtected + +▸ `Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +upload private file to fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | `File` | Multer file from express multipart/form-data | + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[uploadProtected](../interfaces/internal-8.internal.IFileService.md#uploadprotected) + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:42 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractFileService`](internal-8.internal.AbstractFileService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractFileService`](internal-8.internal.AbstractFileService.md) + +#### Implementation of + +[IFileService](../interfaces/internal-8.internal.IFileService.md).[withTransaction](../interfaces/internal-8.internal.IFileService.md#withtransaction) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md new file mode 100644 index 0000000000..6410701fa6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractFulfillmentService.md @@ -0,0 +1,392 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractFulfillmentService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractFulfillmentService + +Fulfillment Provider interface +Fullfillment provider plugin services should extend the AbstractFulfillmentService from this file + +## Implements + +- [`FulfillmentService`](../interfaces/internal-8.internal.FulfillmentService.md) + +## Properties + +### config + +• `Protected` `Optional` `Readonly` **config**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:79 + +___ + +### container + +• `Protected` `Readonly` **container**: [`MedusaContainer`](../modules/internal-8.md#medusacontainer) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:78 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:81 + +## Methods + +### calculatePrice + +▸ `Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> + +Used to calculate a price for a given shipping option. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `optionData` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<`number`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[calculatePrice](../interfaces/internal-8.internal.FulfillmentService.md#calculateprice) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:87 + +___ + +### canCalculate + +▸ `Abstract` **canCalculate**(`data`): `Promise`<`boolean`\> + +Used to determine if a shipping option can have a calculated price + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[canCalculate](../interfaces/internal-8.internal.FulfillmentService.md#cancalculate) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:86 + +___ + +### cancelFulfillment + +▸ `Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\> + +Cancel a fulfillment using data from the fulfillment + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillment` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | + +#### Returns + +`Promise`<`any`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[cancelFulfillment](../interfaces/internal-8.internal.FulfillmentService.md#cancelfulfillment) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:89 + +___ + +### createFulfillment + +▸ `Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata)\> + +Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order. +The returned value of this method will populate the `fulfillment.data` field. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingMethodData`](../modules/internal-8.md#shippingmethoddata) | +| `items` | [`LineItem`](internal-3.LineItem.md)[] | +| `order` | [`Order`](internal-3.Order.md) | +| `fulfillment` | [`Fulfillment`](internal-3.Fulfillment.md) | + +#### Returns + +`Promise`<[`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata)\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[createFulfillment](../interfaces/internal-8.internal.FulfillmentService.md#createfulfillment) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:88 + +___ + +### createReturn + +▸ `Abstract` **createReturn**(`returnOrder`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +Used to create a return order. Should return the data necessary for future +operations on the return; in particular the data may be used to receive +documents attached to the return. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnOrder` | [`CreateReturnType`](../modules/internal-8.md#createreturntype) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[createReturn](../interfaces/internal-8.internal.FulfillmentService.md#createreturn) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:90 + +___ + +### getFulfillmentDocuments + +▸ `Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents associated with a fulfillment. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | + +#### Returns + +`Promise`<`any`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[getFulfillmentDocuments](../interfaces/internal-8.internal.FulfillmentService.md#getfulfillmentdocuments) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:91 + +___ + +### getFulfillmentOptions + +▸ `Abstract` **getFulfillmentOptions**(): `Promise`<`any`[]\> + +Called before a shipping option is created in Admin. The method should +return all of the options that the fulfillment provider can be used with, +and it is here the distinction between different shipping options are +enforced. For example, a fulfillment provider may offer Standard Shipping +and Express Shipping as fulfillment options, it is up to the store operator +to create shipping options in Medusa that are offered to the customer. + +#### Returns + +`Promise`<`any`[]\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[getFulfillmentOptions](../interfaces/internal-8.internal.FulfillmentService.md#getfulfillmentoptions) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:83 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the fulfillment plugin provider + +#### Returns + +`string` + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[getIdentifier](../interfaces/internal-8.internal.FulfillmentService.md#getidentifier) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:82 + +___ + +### getReturnDocuments + +▸ `Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a return order. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`any`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[getReturnDocuments](../interfaces/internal-8.internal.FulfillmentService.md#getreturndocuments) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:92 + +___ + +### getShipmentDocuments + +▸ `Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a shipment. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`any`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[getShipmentDocuments](../interfaces/internal-8.internal.FulfillmentService.md#getshipmentdocuments) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:93 + +___ + +### retrieveDocuments + +▸ `Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillmentData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `documentType` | ``"label"`` \| ``"invoice"`` | + +#### Returns + +`Promise`<`any`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[retrieveDocuments](../interfaces/internal-8.internal.FulfillmentService.md#retrievedocuments) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:94 + +___ + +### validateFulfillmentData + +▸ `Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +Called before a shipping method is set on a cart to ensure that the data +sent with the shipping method is valid. The data object may contain extra +data about the shipment such as an id of a drop point. It is up to the +fulfillment provider to enforce that the correct data is being sent +through. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `optionData` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +the data to populate `cart.shipping_methods.$.data` this + is usually important for future actions like generating shipping labels + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[validateFulfillmentData](../interfaces/internal-8.internal.FulfillmentService.md#validatefulfillmentdata) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:84 + +___ + +### validateOption + +▸ `Abstract` **validateOption**(`data`): `Promise`<`boolean`\> + +Called before a shipping option is created in Admin. Use this to ensure +that a fulfillment option does in fact exist. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | + +#### Returns + +`Promise`<`boolean`\> + +#### Implementation of + +[FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md).[validateOption](../interfaces/internal-8.internal.FulfillmentService.md#validateoption) + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md new file mode 100644 index 0000000000..4dda8b5114 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractNotificationService.md @@ -0,0 +1,304 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractNotificationService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractNotificationService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractNotificationService`** + +## Implements + +- [`INotificationService`](../interfaces/internal-8.internal.INotificationService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[__configModule__](../interfaces/internal-8.internal.INotificationService.md#__configmodule__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[__container__](../interfaces/internal-8.internal.INotificationService.md#__container__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[__moduleDeclaration__](../interfaces/internal-8.internal.INotificationService.md#__moduledeclaration__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[manager_](../interfaces/internal-8.internal.INotificationService.md#manager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[transactionManager_](../interfaces/internal-8.internal.INotificationService.md#transactionmanager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:12 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Implementation of + +INotificationService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[atomicPhase_](../interfaces/internal-8.internal.INotificationService.md#atomicphase_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:13 + +___ + +### resendNotification + +▸ `Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `notification` | `unknown` | +| `config` | `unknown` | +| `attachmentGenerator` | `unknown` | + +#### Returns + +`Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[resendNotification](../interfaces/internal-8.internal.INotificationService.md#resendnotification) + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:15 + +___ + +### sendNotification + +▸ `Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` | +| `data` | `unknown` | +| `attachmentGenerator` | `unknown` | + +#### Returns + +`Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[sendNotification](../interfaces/internal-8.internal.INotificationService.md#sendnotification) + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:14 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[shouldRetryTransaction_](../interfaces/internal-8.internal.INotificationService.md#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractNotificationService`](internal-8.internal.AbstractNotificationService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractNotificationService`](internal-8.internal.AbstractNotificationService.md) + +#### Implementation of + +[INotificationService](../interfaces/internal-8.internal.INotificationService.md).[withTransaction](../interfaces/internal-8.internal.INotificationService.md#withtransaction) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md new file mode 100644 index 0000000000..2cda0d4f8b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentProcessor.md @@ -0,0 +1,326 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractPaymentProcessor + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractPaymentProcessor + +Payment processor in charge of creating , managing and processing a payment + +## Implements + +- [`PaymentProcessor`](../interfaces/internal-8.internal.PaymentProcessor.md) + +## Properties + +### config + +• `Protected` `Optional` `Readonly` **config**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:88 + +___ + +### container + +• `Protected` `Readonly` **container**: [`MedusaContainer`](../modules/internal-8.md#medusacontainer-1) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:87 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:90 + +## Methods + +### authorizePayment + +▸ `Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| { `data`: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +Authorize an existing session if it is not already authorized + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `context` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| { `data`: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[authorizePayment](../interfaces/internal-8.internal.PaymentProcessor.md#authorizepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:93 + +___ + +### cancelPayment + +▸ `Abstract` **cancelPayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Cancel an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[cancelPayment](../interfaces/internal-8.internal.PaymentProcessor.md#cancelpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:97 + +___ + +### capturePayment + +▸ `Abstract` **capturePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Capture an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[capturePayment](../interfaces/internal-8.internal.PaymentProcessor.md#capturepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:92 + +___ + +### deletePayment + +▸ `Abstract` **deletePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Delete an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[deletePayment](../interfaces/internal-8.internal.PaymentProcessor.md#deletepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:99 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the payment plugin provider + +#### Returns + +`string` + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[getIdentifier](../interfaces/internal-8.internal.PaymentProcessor.md#getidentifier) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:91 + +___ + +### getPaymentStatus + +▸ `Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +Return the status of the session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[getPaymentStatus](../interfaces/internal-8.internal.PaymentProcessor.md#getpaymentstatus) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:100 + +___ + +### initiatePayment + +▸ `Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +Initiate a payment session with the external provider + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`PaymentProcessorContext`](../modules/internal-8.internal.md#paymentprocessorcontext) | + +#### Returns + +`Promise`<[`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[initiatePayment](../interfaces/internal-8.internal.PaymentProcessor.md#initiatepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:98 + +___ + +### refundPayment + +▸ `Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Refund an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `refundAmount` | `number` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[refundPayment](../interfaces/internal-8.internal.PaymentProcessor.md#refundpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:101 + +___ + +### retrievePayment + +▸ `Abstract` **retrievePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Retrieve an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[retrievePayment](../interfaces/internal-8.internal.PaymentProcessor.md#retrievepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:102 + +___ + +### updatePayment + +▸ `Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +Update an existing payment session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`PaymentProcessorContext`](../modules/internal-8.internal.md#paymentprocessorcontext) | + +#### Returns + +`Promise`<`void` \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[updatePayment](../interfaces/internal-8.internal.PaymentProcessor.md#updatepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:103 + +___ + +### updatePaymentData + +▸ `Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +Update the session data for a payment session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `sessionId` | `string` | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](../interfaces/internal-8.internal.PaymentProcessorError.md)\> + +#### Implementation of + +[PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md).[updatePaymentData](../interfaces/internal-8.internal.PaymentProcessor.md#updatepaymentdata) + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:104 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md new file mode 100644 index 0000000000..9ac35a4b4b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPaymentService.md @@ -0,0 +1,653 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractPaymentService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractPaymentService + +This will be + +**`Deprecated`** + +in the near future use the AbstractPaymentProcessor instead + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractPaymentService`** + +## Implements + +- [`PaymentService`](../interfaces/internal-8.internal.PaymentService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[__configModule__](../interfaces/internal-8.internal.PaymentService.md#__configmodule__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[__container__](../interfaces/internal-8.internal.PaymentService.md#__container__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[__moduleDeclaration__](../interfaces/internal-8.internal.PaymentService.md#__moduledeclaration__) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[manager_](../interfaces/internal-8.internal.PaymentService.md#manager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[transactionManager_](../interfaces/internal-8.internal.PaymentService.md#transactionmanager_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:112 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Implementation of + +PaymentService.activeManager\_ + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[atomicPhase_](../interfaces/internal-8.internal.PaymentService.md#atomicphase_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePayment + +▸ `Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/internal-8.internal.md#data) ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | +| `context` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<{ `data`: [`Data`](../modules/internal-8.internal.md#data) ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +**`Deprecated`** + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[authorizePayment](../interfaces/internal-8.internal.PaymentService.md#authorizepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:152 + +___ + +### cancelPayment + +▸ `Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](internal-3.Payment.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[cancelPayment](../interfaces/internal-8.internal.PaymentService.md#cancelpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:167 + +___ + +### capturePayment + +▸ `Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](internal-3.Payment.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[capturePayment](../interfaces/internal-8.internal.PaymentService.md#capturepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:159 + +___ + +### createPayment + +▸ `Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `context` | [`Cart`](internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) | The type of this argument is meant to be temporary and once the previous method signature will be removed, the type will only be PaymentContext instead of Cart & PaymentContext | + +#### Returns + +`Promise`<[`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[createPayment](../interfaces/internal-8.internal.PaymentService.md#createpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:126 + +▸ `Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use `createPayment(context: Cart & PaymentContext): Promise` instead + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[createPayment](../interfaces/internal-8.internal.PaymentService.md#createpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:131 + +___ + +### deletePayment + +▸ `Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | + +#### Returns + +`Promise`<`void`\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[deletePayment](../interfaces/internal-8.internal.PaymentService.md#deletepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:171 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[getIdentifier](../interfaces/internal-8.internal.PaymentService.md#getidentifier) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:113 + +___ + +### getPaymentData + +▸ `Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[getPaymentData](../interfaces/internal-8.internal.PaymentService.md#getpaymentdata) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:117 + +___ + +### getStatus + +▸ `Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[getStatus](../interfaces/internal-8.internal.PaymentService.md#getstatus) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:179 + +___ + +### refundPayment + +▸ `Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](internal-3.Payment.md) | +| `refundAmount` | `number` | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[refundPayment](../interfaces/internal-8.internal.PaymentService.md#refundpayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:163 + +___ + +### retrievePayment + +▸ `Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentData` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[retrievePayment](../interfaces/internal-8.internal.PaymentService.md#retrievepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:135 + +___ + +### retrieveSavedMethods + +▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)[]\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](internal-3.Customer.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)[]\> + +**`Deprecated`** + +in the near future + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[retrieveSavedMethods](../interfaces/internal-8.internal.PaymentService.md#retrievesavedmethods) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:175 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[shouldRetryTransaction_](../interfaces/internal-8.internal.PaymentService.md#shouldretrytransaction_) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### updatePayment + +▸ `Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | | +| `context` | [`Cart`](internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) | The type of this argument is meant to be temporary and once the previous method signature will be removed, the type will only be PaymentContext instead of Cart & PaymentContext | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +it return either a PaymentSessionResponse or PaymentSessionResponse["session_data"] to maintain backward compatibility + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[updatePayment](../interfaces/internal-8.internal.PaymentService.md#updatepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:142 + +▸ `Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use `updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise` instead + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[updatePayment](../interfaces/internal-8.internal.PaymentService.md#updatepayment) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:148 + +___ + +### updatePaymentData + +▸ `Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | +| `data` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[updatePaymentData](../interfaces/internal-8.internal.PaymentService.md#updatepaymentdata) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:121 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) + +#### Implementation of + +[PaymentService](../interfaces/internal-8.internal.PaymentService.md).[withTransaction](../interfaces/internal-8.internal.PaymentService.md#withtransaction) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md new file mode 100644 index 0000000000..d71c821acd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractPriceSelectionStrategy.md @@ -0,0 +1,253 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractPriceSelectionStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractPriceSelectionStrategy + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AbstractPriceSelectionStrategy`** + +## Implements + +- [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### calculateVariantPrice + +▸ `Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/internal-8.internal.md#priceselectionresult)\>\> + +Calculate the original and discount price for a given variant in a set of +circumstances described in the context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | { `quantity?`: `number` ; `taxRates`: [`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[] ; `variantId`: `string` }[] | - | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | Details relevant to determine the correct pricing of the variant | + +#### Returns + +`Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/internal-8.internal.md#priceselectionresult)\>\> + +pricing details in an object containing the calculated lowest price, +the default price an all valid prices for the given variant + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/internal-8.internal.IPriceSelectionStrategy.md).[calculateVariantPrice](../interfaces/internal-8.internal.IPriceSelectionStrategy.md#calculatevariantprice) + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:26 + +___ + +### onVariantsPricesUpdate + +▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> + +Notify price selection strategy that variants prices have been updated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantIds` | `string`[] | The ids of the updated variants | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/internal-8.internal.IPriceSelectionStrategy.md).[onVariantsPricesUpdate](../interfaces/internal-8.internal.IPriceSelectionStrategy.md#onvariantspricesupdate) + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:31 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](internal-8.internal.AbstractPriceSelectionStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AbstractPriceSelectionStrategy`](internal-8.internal.AbstractPriceSelectionStrategy.md) + +#### Implementation of + +[IPriceSelectionStrategy](../interfaces/internal-8.internal.IPriceSelectionStrategy.md).[withTransaction](../interfaces/internal-8.internal.IPriceSelectionStrategy.md#withtransaction) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md new file mode 100644 index 0000000000..4eaf18a23e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AbstractTaxService.md @@ -0,0 +1,76 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AbstractTaxService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AbstractTaxService + +Interface to be implemented by tax provider plugins. The interface defines a +single method `getTaxLines` that returns numerical rates to apply to line +items and shipping methods. + +## Hierarchy + +- `unknown` + + ↳ **`AbstractTaxService`** + +## Implements + +- [`ITaxService`](../interfaces/internal-8.internal.ITaxService.md) + +## Properties + +### identifier + +▪ `Static` `Protected` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:54 + +## Methods + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:55 + +___ + +### getTaxLines + +▸ `Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../modules/internal-8.md#providertaxline)[]\> + +Retrieves the numerical tax lines for a calculation context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemLines` | [`ItemTaxCalculationLine`](../modules/internal-8.internal.md#itemtaxcalculationline)[] | the line item calculation lines | +| `shippingLines` | [`ShippingTaxCalculationLine`](../modules/internal-8.internal.md#shippingtaxcalculationline)[] | - | +| `context` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | other details relevant to the tax determination | + +#### Returns + +`Promise`<[`ProviderTaxLine`](../modules/internal-8.md#providertaxline)[]\> + +numerical tax rates that should apply to the provided calculation + lines + +#### Implementation of + +[ITaxService](../interfaces/internal-8.internal.ITaxService.md).[getTaxLines](../interfaces/internal-8.internal.ITaxService.md#gettaxlines) + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:56 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md new file mode 100644 index 0000000000..05e3241f77 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminCreateUserRequest.md @@ -0,0 +1,84 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminCreateUserRequest + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminCreateUserRequest + +**`Schema`** + +AdminCreateUserRequest +type: object +required: + - email + - password +properties: + email: + description: "The User's email." + type: string + format: email + first_name: + description: "The first name of the User." + type: string + last_name: + description: "The last name of the User." + type: string + role: + description: "The role assigned to the user. These roles don't provide any different privileges." + type: string + enum: [admin, member, developer] + password: + description: "The User's password." + type: string + format: password + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:94 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:95 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:96 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:98 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/create-user.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md new file mode 100644 index 0000000000..753f1a7663 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteDiscountsDiscountConditionsConditionBatchParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteDiscountsDiscountConditionsConditionBatchParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminDeleteDiscountsDiscountConditionsConditionBatchParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md new file mode 100644 index 0000000000..e02caeeff4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteDiscountsDiscountConditionsConditionParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteDiscountsDiscountConditionsConditionParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminDeleteDiscountsDiscountConditionsConditionParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md new file mode 100644 index 0000000000..4e8a42480a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeletePriceListPricesPricesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeletePriceListPricesPricesReq + +**`Schema`** + +AdminDeletePriceListPricesPricesReq +type: object +properties: + price_ids: + description: The price IDs of the Money Amounts to delete. + type: array + items: + type: string + +## Properties + +### price\_ids + +• **price\_ids**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:81 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md new file mode 100644 index 0000000000..fbfe836433 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeletePriceListsPriceListProductsPricesBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeletePriceListsPriceListProductsPricesBatchReq + +**`Schema`** + +AdminDeletePriceListsPriceListProductsPricesBatchReq +type: object +properties: + product_ids: + description: The IDs of the products to delete their associated prices. + type: array + items: + type: string + +## Properties + +### product\_ids + +• **product\_ids**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/delete-products-prices-batch.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md new file mode 100644 index 0000000000..37089319af --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteProductCategoriesCategoryProductsBatchParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteProductCategoriesCategoryProductsBatchParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminDeleteProductCategoriesCategoryProductsBatchParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md new file mode 100644 index 0000000000..2c7a1a0837 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteProductCategoriesCategoryProductsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteProductCategoriesCategoryProductsBatchReq + +**`Schema`** + +AdminDeleteProductCategoriesCategoryProductsBatchReq +type: object +required: + - product_ids +properties: + product_ids: + description: The IDs of the products to delete from the Product Category. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchProductCategory`](internal-8.ProductBatchProductCategory.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/delete-products-batch.d.ts:100 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md new file mode 100644 index 0000000000..143f75a0a1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeletePublishableApiKeySalesChannelsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeletePublishableApiKeySalesChannelsBatchReq + +**`Schema`** + +AdminDeletePublishableApiKeySalesChannelsBatchReq +type: object +required: + - sales_channel_ids +properties: + sales_channel_ids: + description: The IDs of the sales channels to remove from the publishable API key + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the sales channel + +## Properties + +### sales\_channel\_ids + +• **sales\_channel\_ids**: [`ProductBatchSalesChannel`](internal-8.ProductBatchSalesChannel.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/delete-channels-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md new file mode 100644 index 0000000000..eb64c4072d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteSalesChannelsChannelProductsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteSalesChannelsChannelProductsBatchReq + +**`Schema`** + +AdminDeleteSalesChannelsChannelProductsBatchReq +type: object +required: + - product_ids +properties: + product_ids: + description: The IDs of the products to remove from the Sales Channel. + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a product + type: string + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchSalesChannel`](internal-8.ProductBatchSalesChannel.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/delete-products-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md new file mode 100644 index 0000000000..fab506d0cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteSalesChannelsChannelStockLocationsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteSalesChannelsChannelStockLocationsReq + +**`Schema`** + +AdminDeleteSalesChannelsChannelStockLocationsReq +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string + +## Properties + +### location\_id + +• **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/remove-stock-location.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md new file mode 100644 index 0000000000..50a6f5ea2b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductTypesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateProductTypesParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..441dee37fa --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateProductTypesReq + +**`Schema`** + +AdminDeleteTaxRatesTaxRateProductTypesReq +type: object +required: + - product_types +properties: + product_types: + type: array + description: "The IDs of the product types to remove their association with this tax rate." + items: + type: string + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md new file mode 100644 index 0000000000..68c8d130ab --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateProductsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..9c44c436c1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateProductsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateProductsReq + +**`Schema`** + +AdminDeleteTaxRatesTaxRateProductsReq +type: object +required: + - products +properties: + products: + type: array + description: "The IDs of the products to remove their association with this tax rate." + items: + type: string + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md new file mode 100644 index 0000000000..07c76a00b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..cb151fa6dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq + +**`Schema`** + +AdminDeleteTaxRatesTaxRateShippingOptionsReq +type: object +required: + - shipping_options +properties: + shipping_options: + type: array + description: "The IDs of the shipping options to remove their association with this tax rate." + items: + type: string + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md new file mode 100644 index 0000000000..ce7cc82c23 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminDeleteUploadsReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminDeleteUploadsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminDeleteUploadsReq + +**`Schema`** + +AdminDeleteUploadsReq +type: object +required: + - file_key +properties: + file_key: + description: "key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly." + type: string + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/delete-upload.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md new file mode 100644 index 0000000000..207cc96d32 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetDiscountParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetDiscountParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md new file mode 100644 index 0000000000..4c2408ed1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDiscountsDiscountCodeParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetDiscountsDiscountCodeParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetDiscountsDiscountCodeParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md new file mode 100644 index 0000000000..e65747c8d3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetDraftOrdersParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetDraftOrdersParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetDraftOrdersParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:60 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:61 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md new file mode 100644 index 0000000000..66d0cacf4d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetGiftCardsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetGiftCardsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetGiftCardsParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:59 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:60 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:61 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md new file mode 100644 index 0000000000..ba464f2bba --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetInventoryItemsItemLocationLevelsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetInventoryItemsItemLocationLevelsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetInventoryItemsItemLocationLevelsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### location\_id + +• `Optional` **location\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-location-levels.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md new file mode 100644 index 0000000000..c23ec8551b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsItemParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetInventoryItemsItemParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetInventoryItemsItemParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetInventoryItemsItemParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md new file mode 100644 index 0000000000..9b58c872e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetInventoryItemsParams.md @@ -0,0 +1,199 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetInventoryItemsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetInventoryItemsParams + +## Hierarchy + +- [`AdminGetInventoryItemsParams_base`](../modules/internal-8.md#admingetinventoryitemsparams_base) + + ↳ **`AdminGetInventoryItemsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +AdminGetInventoryItemsParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +AdminGetInventoryItemsParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### height + +• `Optional` **height**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:106 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:103 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:96 + +___ + +### length + +• `Optional` **length**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:105 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +AdminGetInventoryItemsParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:98 + +___ + +### material + +• `Optional` **material**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:102 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:101 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +AdminGetInventoryItemsParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:100 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:97 + +___ + +### requires\_shipping + +• `Optional` **requires\_shipping**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:108 + +___ + +### sku + +• `Optional` **sku**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:99 + +___ + +### weight + +• `Optional` **weight**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:104 + +___ + +### width + +• `Optional` **width**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:107 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md new file mode 100644 index 0000000000..b77814e944 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotesParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetNotesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetNotesParams + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:60 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:61 + +___ + +### resource\_id + +• `Optional` **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md new file mode 100644 index 0000000000..8f96dc9b02 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetNotificationsParams.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetNotificationsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetNotificationsParams + +## Properties + +### event\_name + +• `Optional` **event\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:69 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:68 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:67 + +___ + +### include\_resends + +• `Optional` **include\_resends**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:73 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:65 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:66 + +___ + +### resource\_id + +• `Optional` **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:71 + +___ + +### resource\_type + +• `Optional` **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:70 + +___ + +### to + +• `Optional` **to**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md new file mode 100644 index 0000000000..6f2a82c647 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersOrderParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetOrdersOrderParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetOrdersOrderParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetOrdersOrderParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md new file mode 100644 index 0000000000..256322fe6c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetOrdersParams.md @@ -0,0 +1,277 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetOrdersParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetOrdersParams + +## Hierarchy + +- [`AdminListOrdersSelector`](internal-8.AdminListOrdersSelector.md) + + ↳ **`AdminGetOrdersParams`** + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[canceled_at](internal-8.AdminListOrdersSelector.md#canceled_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:101 + +___ + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[cart_id](internal-8.AdminListOrdersSelector.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:94 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[created_at](internal-8.AdminListOrdersSelector.md#created_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:102 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[currency_code](internal-8.AdminListOrdersSelector.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:98 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[customer_id](internal-8.AdminListOrdersSelector.md#customer_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:95 + +___ + +### display\_id + +• `Optional` **display\_id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[display_id](internal-8.AdminListOrdersSelector.md#display_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:93 + +___ + +### email + +• `Optional` **email**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[email](internal-8.AdminListOrdersSelector.md#email) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:96 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:199 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:200 + +___ + +### fulfillment\_status + +• `Optional` **fulfillment\_status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[fulfillment_status](internal-8.AdminListOrdersSelector.md#fulfillment_status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:91 + +___ + +### id + +• `Optional` **id**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[id](internal-8.AdminListOrdersSelector.md#id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:89 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:198 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:197 + +___ + +### payment\_status + +• `Optional` **payment\_status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[payment_status](internal-8.AdminListOrdersSelector.md#payment_status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:92 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[q](internal-8.AdminListOrdersSelector.md#q) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:88 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` \| `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[region_id](internal-8.AdminListOrdersSelector.md#region_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:97 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[sales_channel_id](internal-8.AdminListOrdersSelector.md#sales_channel_id) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:100 + +___ + +### status + +• `Optional` **status**: `string`[] + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[status](internal-8.AdminListOrdersSelector.md#status) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:90 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `string` + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[tax_rate](internal-8.AdminListOrdersSelector.md#tax_rate) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:99 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[AdminListOrdersSelector](internal-8.AdminListOrdersSelector.md).[updated_at](internal-8.AdminListOrdersSelector.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:103 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md new file mode 100644 index 0000000000..09afe34931 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPaymentCollectionsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetPaymentCollectionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetPaymentCollectionsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetPaymentCollectionsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md new file mode 100644 index 0000000000..57fa24e174 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListPaginationParams.md @@ -0,0 +1,193 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetPriceListPaginationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetPriceListPaginationParams + +## Hierarchy + +- [`FilterablePriceListProps`](internal-8.internal.FilterablePriceListProps.md) + + ↳ **`AdminGetPriceListPaginationParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[created_at](internal-8.internal.FilterablePriceListProps.md#created_at) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:19 + +___ + +### customer\_groups + +• `Optional` **customer\_groups**: `string`[] + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[customer_groups](internal-8.internal.FilterablePriceListProps.md#customer_groups) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:16 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[deleted_at](internal-8.internal.FilterablePriceListProps.md#deleted_at) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:21 + +___ + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[description](internal-8.internal.FilterablePriceListProps.md#description) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:17 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:163 + +___ + +### id + +• `Optional` **id**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[id](internal-8.internal.FilterablePriceListProps.md#id) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:12 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:162 + +___ + +### name + +• `Optional` **name**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[name](internal-8.internal.FilterablePriceListProps.md#name) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:15 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:161 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:164 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[q](internal-8.internal.FilterablePriceListProps.md#q) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:13 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md)[] + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[status](internal-8.internal.FilterablePriceListProps.md#status) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:14 + +___ + +### type + +• `Optional` **type**: [`PriceListType`](../enums/internal-3.PriceListType.md)[] + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[type](internal-8.internal.FilterablePriceListProps.md#type) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:18 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterablePriceListProps](internal-8.internal.FilterablePriceListProps.md).[updated_at](internal-8.internal.FilterablePriceListProps.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:20 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md similarity index 54% rename from www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md index e6f8e88175..78eb6652d9 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminGetPriceListsPriceListProductsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetPriceListsPriceListProductsParams -[internal](../modules/internal-17.md).AdminGetPriceListsPriceListProductsParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetPriceListsPriceListProductsParams ## Hierarchy -- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-17.md#admingetpricelistspricelistproductsparams_base) +- [`AdminGetPriceListsPriceListProductsParams_base`](../modules/internal-8.md#admingetpricelistspricelistproductsparams_base) ↳ **`AdminGetPriceListsPriceListProductsParams`** @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:180 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:170 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:188 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:178 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:190 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:180 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:183 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:173 ___ @@ -60,7 +64,7 @@ AdminGetPriceListsPriceListProductsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -74,7 +78,7 @@ AdminGetPriceListsPriceListProductsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 ___ @@ -84,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:184 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174 ___ @@ -94,7 +98,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:177 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:167 ___ @@ -104,7 +108,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:185 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:175 ___ @@ -118,7 +122,7 @@ AdminGetPriceListsPriceListProductsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -132,7 +136,7 @@ AdminGetPriceListsPriceListProductsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -142,7 +146,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:187 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:177 ___ @@ -152,17 +156,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:178 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:168 ___ ### status -• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[] +• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md)[] #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:179 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:169 ___ @@ -172,7 +176,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:181 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:171 ___ @@ -182,7 +186,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:182 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:172 ___ @@ -192,7 +196,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:186 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:176 ___ @@ -202,4 +206,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:189 +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:179 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md new file mode 100644 index 0000000000..180c280ab5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoriesParams.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductCategoriesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductCategoriesParams + +## Hierarchy + +- [`AdminGetProductCategoriesParams_base`](../modules/internal-8.md#admingetproductcategoriesparams_base) + + ↳ **`AdminGetProductCategoriesParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +AdminGetProductCategoriesParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +AdminGetProductCategoriesParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:70 + +___ + +### include\_descendants\_tree + +• `Optional` **include\_descendants\_tree**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:71 + +___ + +### is\_active + +• `Optional` **is\_active**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:73 + +___ + +### is\_internal + +• `Optional` **is\_internal**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:72 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +AdminGetProductCategoriesParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +AdminGetProductCategoriesParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### parent\_category\_id + +• `Optional` **parent\_category\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:74 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md new file mode 100644 index 0000000000..ae96332895 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductCategoryParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductCategoryParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductCategoryParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetProductCategoryParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md new file mode 100644 index 0000000000..93f4508672 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTagsPaginationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductTagsPaginationParams + +## Hierarchy + +- **`AdminGetProductTagsPaginationParams`** + + ↳ [`AdminGetProductTagsParams`](internal-8.internal.AdminGetProductTagsParams.md) + +## Properties + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:125 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:126 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md new file mode 100644 index 0000000000..d5e1acd444 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTagsParams.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductTagsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductTagsParams + +## Hierarchy + +- [`AdminGetProductTagsPaginationParams`](internal-8.internal.AdminGetProductTagsPaginationParams.md) + + ↳ **`AdminGetProductTagsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:132 + +___ + +### discount\_condition\_id + +• `Optional` **discount\_condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:135 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:129 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal-8.internal.AdminGetProductTagsPaginationParams.md).[limit](internal-8.internal.AdminGetProductTagsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:125 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[AdminGetProductTagsPaginationParams](internal-8.internal.AdminGetProductTagsPaginationParams.md).[offset](internal-8.internal.AdminGetProductTagsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:126 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:134 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:130 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:133 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:131 diff --git a/www/apps/docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md similarity index 58% rename from www/apps/docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md index 8dee77219b..6f9c393d67 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-19.AdminGetProductTypesParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductTypesParams.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetProductTypesParams -[internal](../modules/internal-19.md).AdminGetProductTypesParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductTypesParams ## Hierarchy @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:135 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:127 ___ @@ -26,17 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:138 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:130 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:132 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:124 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -64,7 +68,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -74,7 +78,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:137 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:129 ___ @@ -84,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:133 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:125 ___ @@ -94,14 +98,14 @@ ___ #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:136 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:128 ___ ### value -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:134 +packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:126 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md new file mode 100644 index 0000000000..5c4e7e80b3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsParams.md @@ -0,0 +1,317 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductsParams + +API Level DTOs + Validation rules + +## Hierarchy + +- [`FilterableProductProps`](internal-8.FilterableProductProps.md) + + ↳ **`AdminGetProductsParams`** + +## Properties + +### category\_id + +• `Optional` **category\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[category_id](internal-8.FilterableProductProps.md#category_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:22 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[collection_id](internal-8.FilterableProductProps.md#collection_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:13 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[created_at](internal-8.FilterableProductProps.md#created_at) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:24 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[deleted_at](internal-8.FilterableProductProps.md#deleted_at) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:26 + +___ + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[description](internal-8.FilterableProductProps.md#description) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:16 + +___ + +### discount\_condition\_id + +• `Optional` **discount\_condition\_id**: `string` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[discount_condition_id](internal-8.FilterableProductProps.md#discount_condition_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:21 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:222 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:223 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[handle](internal-8.FilterableProductProps.md#handle) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:17 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[id](internal-8.FilterableProductProps.md#id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:9 + +___ + +### include\_category\_children + +• `Optional` **include\_category\_children**: `boolean` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[include_category_children](internal-8.FilterableProductProps.md#include_category_children) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:23 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[is_giftcard](internal-8.FilterableProductProps.md#is_giftcard) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:18 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:221 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:220 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-products.d.ts:224 + +___ + +### price\_list\_id + +• `Optional` **price\_list\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[price_list_id](internal-8.FilterableProductProps.md#price_list_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:12 + +___ + +### q + +• `Optional` **q**: `string` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[q](internal-8.FilterableProductProps.md#q) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:10 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[sales_channel_id](internal-8.FilterableProductProps.md#sales_channel_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:20 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md)[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[status](internal-8.FilterableProductProps.md#status) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:11 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[tags](internal-8.FilterableProductProps.md#tags) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:14 + +___ + +### title + +• `Optional` **title**: `string` + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[title](internal-8.FilterableProductProps.md#title) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:15 + +___ + +### type\_id + +• `Optional` **type\_id**: `string`[] + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[type_id](internal-8.FilterableProductProps.md#type_id) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:19 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Inherited from + +[FilterableProductProps](internal-8.FilterableProductProps.md).[updated_at](internal-8.FilterableProductProps.md#updated_at) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md new file mode 100644 index 0000000000..a17c48ce59 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetProductsVariantsParams.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetProductsVariantsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetProductsVariantsParams + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-variants.d.ts:53 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-variants.d.ts:52 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-variants.d.ts:55 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/list-variants.d.ts:54 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md new file mode 100644 index 0000000000..29bde73c0c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsPaginationParams.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsPaginationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetRegionsPaginationParams + +## Hierarchy + +- **`AdminGetRegionsPaginationParams`** + + ↳ [`AdminGetRegionsParams`](internal-8.internal.AdminGetRegionsParams.md) + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:140 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:141 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md new file mode 100644 index 0000000000..327f0a7b07 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsParams.md @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetRegionsParams + +## Hierarchy + +- [`AdminGetRegionsPaginationParams`](internal-8.internal.AdminGetRegionsPaginationParams.md) + + ↳ **`AdminGetRegionsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:144 + +___ + +### deleted\_at + +• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:146 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal-8.internal.AdminGetRegionsPaginationParams.md).[limit](internal-8.internal.AdminGetRegionsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:140 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[AdminGetRegionsPaginationParams](internal-8.internal.AdminGetRegionsPaginationParams.md).[offset](internal-8.internal.AdminGetRegionsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:141 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:145 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md new file mode 100644 index 0000000000..ab5021b041 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md @@ -0,0 +1,46 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetRegionsRegionFulfillmentOptionsRes + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetRegionsRegionFulfillmentOptionsRes + +**`Schema`** + +AdminGetRegionsRegionFulfillmentOptionsRes +type: object +required: + - fulfillment_options +properties: + fulfillment_options: + type: array + description: Fulfillment providers details. + items: + type: object + required: + - provider_id + - options + properties: + provider_id: + description: ID of the fulfillment provider + type: string + options: + description: fulfillment provider options + type: array + items: + type: object + example: + - id: "manual-fulfillment" + - id: "manual-fulfillment-return" + is_return: true + +## Properties + +### fulfillment\_options + +• **fulfillment\_options**: [`FulfillmentOption`](internal-8.internal.FulfillmentOption.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:121 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md new file mode 100644 index 0000000000..1ccb12bede --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReservationsParams.md @@ -0,0 +1,139 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetReservationsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetReservationsParams + +## Hierarchy + +- [`AdminGetReservationsParams_base`](../modules/internal-8.md#admingetreservationsparams_base) + + ↳ **`AdminGetReservationsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:153 + +___ + +### created\_by + +• `Optional` **created\_by**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:151 + +___ + +### description + +• `Optional` **description**: `string` \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:154 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +AdminGetReservationsParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +AdminGetReservationsParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### inventory\_item\_id + +• `Optional` **inventory\_item\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:149 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +AdminGetReservationsParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### line\_item\_id + +• `Optional` **line\_item\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:150 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:148 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +AdminGetReservationsParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### quantity + +• `Optional` **quantity**: [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:152 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md new file mode 100644 index 0000000000..cfc5591d75 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetReturnsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetReturnsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetReturnsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:57 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:58 diff --git a/www/apps/docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md similarity index 56% rename from www/apps/docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md index 01e08d0384..e3fe824ed6 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-25.AdminGetSalesChannelsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSalesChannelsParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminGetSalesChannelsParams -[internal](../modules/internal-25.md).AdminGetSalesChannelsParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetSalesChannelsParams ## Hierarchy -- [`AdminGetSalesChannelsParams_base`](../modules/internal-25.md#admingetsaleschannelsparams_base) +- [`AdminGetSalesChannelsParams_base`](../modules/internal-8.md#admingetsaleschannelsparams_base) ↳ **`AdminGetSalesChannelsParams`** @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:148 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:138 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:150 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:140 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:147 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:137 ___ @@ -50,7 +54,7 @@ AdminGetSalesChannelsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -64,7 +68,7 @@ AdminGetSalesChannelsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 ___ @@ -74,7 +78,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:144 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:134 ___ @@ -88,7 +92,7 @@ AdminGetSalesChannelsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -98,7 +102,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:146 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:136 ___ @@ -112,7 +116,7 @@ AdminGetSalesChannelsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -122,7 +126,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:151 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141 ___ @@ -132,7 +136,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:145 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:135 ___ @@ -142,4 +146,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:149 +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:139 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md new file mode 100644 index 0000000000..13492c9187 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetShippingOptionsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetShippingOptionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetShippingOptionsParams + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:73 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:72 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md new file mode 100644 index 0000000000..b743d71e03 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsLocationParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetStockLocationsLocationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetStockLocationsLocationParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetStockLocationsLocationParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md new file mode 100644 index 0000000000..72ee0d8f37 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetStockLocationsParams.md @@ -0,0 +1,109 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetStockLocationsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetStockLocationsParams + +## Hierarchy + +- [`AdminGetStockLocationsParams_base`](../modules/internal-8.md#admingetstocklocationsparams_base) + + ↳ **`AdminGetStockLocationsParams`** + +## Properties + +### address\_id + +• `Optional` **address\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:133 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +AdminGetStockLocationsParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +AdminGetStockLocationsParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:131 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +AdminGetStockLocationsParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### name + +• `Optional` **name**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:132 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +AdminGetStockLocationsParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:134 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md new file mode 100644 index 0000000000..c794c53c45 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetSwapsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetSwapsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetSwapsParams + +## Properties + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:58 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md new file mode 100644 index 0000000000..611a4567a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesParams.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetTaxRatesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetTaxRatesParams + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:114 + +___ + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:118 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:119 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:117 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:113 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:116 + +___ + +### rate + +• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:115 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:112 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md new file mode 100644 index 0000000000..3924868e46 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetTaxRatesTaxRateParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetTaxRatesTaxRateParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:75 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md new file mode 100644 index 0000000000..20451a78ad --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetVariantParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetVariantParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminGetVariantParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md new file mode 100644 index 0000000000..dad7b8ce8b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminGetVariantsParams.md @@ -0,0 +1,157 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminGetVariantsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminGetVariantsParams + +## Hierarchy + +- [`AdminPriceSelectionParams`](internal-8.AdminPriceSelectionParams.md) + + ↳ **`AdminGetVariantsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[cart_id](internal-8.AdminPriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[currency_code](internal-8.AdminPriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Inherited from + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[customer_id](internal-8.AdminPriceSelectionParams.md#customer_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:8 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Overrides + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[expand](internal-8.AdminPriceSelectionParams.md#expand) + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:150 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Overrides + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[fields](internal-8.AdminPriceSelectionParams.md#fields) + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:151 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:152 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:154 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:148 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:149 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:147 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[AdminPriceSelectionParams](internal-8.AdminPriceSelectionParams.md).[region_id](internal-8.AdminPriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### title + +• `Optional` **title**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:153 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md new file mode 100644 index 0000000000..0545abdccf --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostAnalyticsConfigAnalyticsConfigReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostAnalyticsConfigAnalyticsConfigReq + +## Properties + +### anonymize + +• `Optional` **anonymize**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/update-analytics-config.d.ts:6 + +___ + +### opt\_out + +• `Optional` **opt\_out**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/update-analytics-config.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md new file mode 100644 index 0000000000..e6a072cfe1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostAnalyticsConfigReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostAnalyticsConfigReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostAnalyticsConfigReq + +## Properties + +### anonymize + +• `Optional` **anonymize**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/create-analytics-config.d.ts:6 + +___ + +### opt\_out + +• **opt\_out**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/create-analytics-config.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md new file mode 100644 index 0000000000..5fcdff0764 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsDiscountParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsDiscountParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDiscountsDiscountParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostDiscountsDiscountParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md new file mode 100644 index 0000000000..547935fd5f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDiscountsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDiscountsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDiscountsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostDiscountsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md new file mode 100644 index 0000000000..6b6fee4cb6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderLineItemsItemReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDraftOrdersDraftOrderLineItemsItemReq + +**`Schema`** + +AdminPostDraftOrdersDraftOrderLineItemsItemReq +type: object +properties: + unit_price: + description: The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price. + type: integer + title: + description: The title of the line item if `variant_id` is not provided. + type: string + quantity: + description: The quantity of the line item. + type: integer + metadata: + description: The optional key-value map with additional details about the Line Item. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:91 + +___ + +### quantity + +• `Optional` **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:90 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:88 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-line-item.d.ts:89 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md new file mode 100644 index 0000000000..c2ba983b3a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md @@ -0,0 +1,84 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderLineItemsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDraftOrdersDraftOrderLineItemsReq + +**`Schema`** + +AdminPostDraftOrdersDraftOrderLineItemsReq +type: object +required: + - quantity +properties: + variant_id: + description: The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted. + type: string + unit_price: + description: The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price. + type: integer + title: + description: The title of the line item if `variant_id` is not provided. + type: string + default: "Custom item" + quantity: + description: The quantity of the line item. + type: integer + metadata: + description: The optional key-value map with additional details about the Line Item. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:97 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:96 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:93 + +___ + +### unit\_price + +• `Optional` **unit\_price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:94 + +___ + +### variant\_id + +• `Optional` **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-line-item.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md new file mode 100644 index 0000000000..97ab75af0d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md @@ -0,0 +1,133 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersDraftOrderReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDraftOrdersDraftOrderReq + +**`Schema`** + +AdminPostDraftOrdersDraftOrderReq +type: object +properties: + region_id: + type: string + description: The ID of the Region to create the Draft Order in. + country_code: + type: string + description: "The 2 character ISO code for the Country." + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + email: + type: string + description: "An email to be used in the Draft Order." + format: email + billing_address: + description: "The Address to be used for billing purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + - type: string + shipping_address: + description: "The Address to be used for shipping purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + - type: string + discounts: + description: "An array of Discount codes to add to the Draft Order." + type: array + items: + type: object + required: + - code + properties: + code: + description: "The code that a Discount is identifed by." + type: string + no_notification_order: + description: "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates." + type: boolean + customer_id: + description: "The ID of the customer this draft order is associated with." + type: string + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:116 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:114 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:119 + +___ + +### discounts + +• `Optional` **discounts**: [`Discount`](internal-8.Discount-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:118 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:115 + +___ + +### no\_notification\_order + +• `Optional` **no\_notification\_order**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:120 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:113 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/update-draft-order.d.ts:117 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md new file mode 100644 index 0000000000..9df94a4626 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostDraftOrdersReq.md @@ -0,0 +1,214 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostDraftOrdersReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostDraftOrdersReq + +**`Schema`** + +AdminPostDraftOrdersReq +type: object +required: + - email + - region_id + - shipping_methods +properties: + status: + description: "The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid." + type: string + enum: [open, completed] + email: + description: "The email of the customer of the draft order" + type: string + format: email + billing_address: + description: "The Address to be used for billing purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + - type: string + shipping_address: + description: "The Address to be used for shipping purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + - type: string + items: + description: The draft order's line items. + type: array + items: + type: object + required: + - quantity + properties: + variant_id: + description: The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted. + type: string + unit_price: + description: The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price. + type: integer + title: + description: The title of the line item if `variant_id` is not provided. + type: string + quantity: + description: The quantity of the line item. + type: integer + metadata: + description: The optional key-value map with additional details about the line item. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + region_id: + description: The ID of the region for the draft order + type: string + discounts: + description: The discounts to add to the draft order + type: array + items: + type: object + required: + - code + properties: + code: + description: The code of the discount to apply + type: string + customer_id: + description: The ID of the customer this draft order is associated with. + type: string + no_notification_order: + description: An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates. + type: boolean + shipping_methods: + description: The shipping methods for the draft order + type: array + items: + type: object + required: + - option_id + properties: + option_id: + description: The ID of the shipping option in use + type: string + data: + description: The optional additional data needed for the shipping method + type: object + price: + description: The price of the shipping method. + type: integer + metadata: + description: The optional key-value map with additional details about the Draft Order. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:186 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:191 + +___ + +### discounts + +• `Optional` **discounts**: [`Discount`](internal-8.Discount.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:190 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:185 + +___ + +### items + +• `Optional` **items**: [`Item`](internal-8.Item.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:188 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:194 + +___ + +### no\_notification\_order + +• `Optional` **no\_notification\_order**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:192 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:189 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:187 + +___ + +### shipping\_methods + +• **shipping\_methods**: [`ShippingMethod`](internal-8.ShippingMethod.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:193 + +___ + +### status + +• `Optional` **status**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/create-draft-order.d.ts:184 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md new file mode 100644 index 0000000000..411454c49d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostGiftCardsGiftCardReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostGiftCardsGiftCardReq + +**`Schema`** + +AdminPostGiftCardsGiftCardReq +type: object +properties: + balance: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers. + ends_at: + type: string + format: date-time + description: The date and time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### balance + +• `Optional` **balance**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:91 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:93 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:92 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:95 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md new file mode 100644 index 0000000000..890a0da589 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostGiftCardsReq.md @@ -0,0 +1,84 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostGiftCardsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostGiftCardsReq + +**`Schema`** + +AdminPostGiftCardsReq +type: object +required: + - region_id +properties: + value: + type: integer + description: The value (excluding VAT) that the Gift Card should represent. + is_disabled: + type: boolean + description: Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers. + ends_at: + type: string + format: date-time + description: The date and time at which the Gift Card should no longer be available. + region_id: + description: The ID of the Region in which the Gift Card can be used. + type: string + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:92 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:93 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:95 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:94 + +___ + +### value + +• `Optional` **value**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:91 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md new file mode 100644 index 0000000000..0dbd55c2ad --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsInventoryItemParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsInventoryItemParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostInventoryItemsInventoryItemParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md new file mode 100644 index 0000000000..9d8f73ee62 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md @@ -0,0 +1,170 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsInventoryItemReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsInventoryItemReq + +**`Schema`** + +AdminPostInventoryItemsInventoryItemReq +type: object +properties: + hs_code: + description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + origin_country: + description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + mid_code: + description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + material: + description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + weight: + description: The weight of the Inventory Item. May be used in shipping rate calculations. + type: number + height: + description: The height of the Inventory Item. May be used in shipping rate calculations. + type: number + width: + description: The width of the Inventory Item. May be used in shipping rate calculations. + type: number + length: + description: The length of the Inventory Item. May be used in shipping rate calculations. + type: number + requires_shipping: + description: Whether the item requires shipping. + type: boolean + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:114 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:110 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:106 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:111 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:108 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:107 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:105 + +___ + +### requires\_shipping + +• `Optional` **requires\_shipping**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:116 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:104 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:115 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:113 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:109 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-inventory-item.d.ts:112 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md new file mode 100644 index 0000000000..474783fba6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsItemLocationLevelsLevelParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsItemLocationLevelsLevelParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostInventoryItemsItemLocationLevelsLevelParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md new file mode 100644 index 0000000000..d329586844 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md @@ -0,0 +1,39 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsItemLocationLevelsLevelReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsItemLocationLevelsLevelReq + +**`Schema`** + +AdminPostInventoryItemsItemLocationLevelsLevelReq +type: object +properties: + stocked_quantity: + description: the total stock quantity of an inventory item at the given location ID + type: number + incoming_quantity: + description: the incoming stock quantity of an inventory item at the given location ID + type: number + +## Properties + +### incoming\_quantity + +• `Optional` **incoming\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-location-level.d.ts:84 + +___ + +### stocked\_quantity + +• `Optional` **stocked\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/update-location-level.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md new file mode 100644 index 0000000000..d1e86ed3a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsItemLocationLevelsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsItemLocationLevelsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostInventoryItemsItemLocationLevelsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md new file mode 100644 index 0000000000..48ec3ed3db --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsItemLocationLevelsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsItemLocationLevelsReq + +**`Schema`** + +AdminPostInventoryItemsItemLocationLevelsReq +type: object +required: + - location_id + - stocked_quantity +properties: + location_id: + description: the ID of the stock location + type: string + stocked_quantity: + description: the stock quantity of the inventory item at this location + type: number + incoming_quantity: + description: the incoming stock quantity of the inventory item at this location + type: number + +## Properties + +### incoming\_quantity + +• `Optional` **incoming\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-location-level.d.ts:93 + +___ + +### location\_id + +• **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-location-level.d.ts:91 + +___ + +### stocked\_quantity + +• **stocked\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-location-level.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md new file mode 100644 index 0000000000..e412c6e1a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostInventoryItemsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md new file mode 100644 index 0000000000..e0f28e0f5d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInventoryItemsReq.md @@ -0,0 +1,211 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInventoryItemsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInventoryItemsReq + +**`Schema`** + +AdminPostInventoryItemsReq +type: object +required: + - variant_id +properties: + variant_id: + description: The ID of the variant to create the inventory item for. + type: string + sku: + description: The unique SKU of the associated Product Variant. + type: string + ean: + description: The EAN number of the item. + type: string + upc: + description: The UPC number of the item. + type: string + barcode: + description: A generic GTIN field for the Product Variant. + type: string + hs_code: + description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + inventory_quantity: + description: The amount of stock kept of the associated Product Variant. + type: integer + default: 0 + allow_backorder: + description: Whether the associated Product Variant can be purchased when out of stock. + type: boolean + manage_inventory: + description: Whether Medusa should keep track of the inventory for the associated Product Variant. + type: boolean + default: true + weight: + description: The weight of the Inventory Item. May be used in shipping rate calculations. + type: number + length: + description: The length of the Inventory Item. May be used in shipping rate calculations. + type: number + height: + description: The height of the Inventory Item. May be used in shipping rate calculations. + type: number + width: + description: The width of the Inventory Item. May be used in shipping rate calculations. + type: number + origin_country: + description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + mid_code: + description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + material: + description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:144 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:138 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:135 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:137 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:142 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:146 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:141 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:140 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:134 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:145 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:143 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:133 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:136 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/create-inventory-item.d.ts:139 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md new file mode 100644 index 0000000000..a52b51e238 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesInviteAcceptReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInvitesInviteAcceptReq + +**`Schema`** + +AdminPostInvitesInviteAcceptReq +type: object +required: + - token + - user +properties: + token: + description: "The token of the invite to accept. This is a unique token generated when the invite was created or resent." + type: string + user: + description: "The details of the user to create." + type: object + required: + - first_name + - last_name + - password + properties: + first_name: + type: string + description: the first name of the User + last_name: + type: string + description: the last name of the User + password: + description: The password for the User + type: string + format: password + +## Properties + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:108 + +___ + +### user + +• **user**: [`AdminPostInvitesInviteAcceptUserReq`](internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:109 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md new file mode 100644 index 0000000000..f1da530da4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesInviteAcceptUserReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInvitesInviteAcceptUserReq + +## Properties + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:74 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:75 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/accept-invite.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md new file mode 100644 index 0000000000..445ace22be --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostInvitesReq.md @@ -0,0 +1,44 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostInvitesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostInvitesReq + +**`Schema`** + +AdminPostInvitesReq +type: object +required: + - user + - role +properties: + user: + description: "The email associated with the invite. Once the invite is accepted, the email will be associated with the created user." + type: string + format: email + role: + description: "The role of the user to be created. This does not actually change the privileges of the user that is eventually created." + type: string + enum: [admin, member, developer] + +## Properties + +### role + +• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:85 + +___ + +### user + +• **user**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/create-invite.d.ts:84 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md new file mode 100644 index 0000000000..30ac3681a1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesNoteReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotesNoteReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostNotesNoteReq + +**`Schema`** + +AdminPostNotesNoteReq +type: object +required: + - value +properties: + value: + type: string + description: The description of the Note. + +## Properties + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/update-note.d.ts:77 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md new file mode 100644 index 0000000000..5d0e007482 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotesReq.md @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostNotesReq + +**`Schema`** + +AdminPostNotesReq +type: object +required: + - resource_id + - resource_type + - value +properties: + resource_id: + type: string + description: The ID of the resource which the Note relates to. For example, an order ID. + resource_type: + type: string + description: The type of resource which the Note relates to. For example, `order`. + value: + type: string + description: The content of the Note to create. + +## Properties + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:88 + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:89 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/create-note.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md new file mode 100644 index 0000000000..ba72f737ae --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostNotificationsNotificationResendReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostNotificationsNotificationResendReq + +**`Schema`** + +AdminPostNotificationsNotificationResendReq +type: object +properties: + to: + description: "A new address or user identifier that the Notification should be sent to. If not provided, the previous `to` field of the notification will be used." + type: string + +## Properties + +### to + +• `Optional` **to**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/resend-notification.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md new file mode 100644 index 0000000000..0730734d95 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrderEditsEditLineItemsLineItemReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrderEditsEditLineItemsLineItemReq + +**`Schema`** + +AdminPostOrderEditsEditLineItemsLineItemReq +type: object +required: + - quantity +properties: + quantity: + description: The quantity to update + type: number + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/update-order-edit-line-item.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md new file mode 100644 index 0000000000..e43d2f9e1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrderEditsEditLineItemsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrderEditsEditLineItemsReq + +**`Schema`** + +AdminPostOrderEditsEditLineItemsReq +type: object +required: + - variant_id + - quantity +properties: + variant_id: + description: The ID of the product variant associated with the item. + type: string + quantity: + description: The quantity of the item. + type: number + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:90 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:89 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/add-line-item.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md new file mode 100644 index 0000000000..62f3715632 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrderEditsOrderEditReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrderEditsOrderEditReq + +**`Schema`** + +AdminPostOrderEditsOrderEditReq +type: object +properties: + internal_note: + description: An optional note to create or update in the order edit. + type: string + +## Properties + +### internal\_note + +• `Optional` **internal\_note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/update-order-edit.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md new file mode 100644 index 0000000000..1fb4f9f2a4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsReq.md @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrderEditsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrderEditsReq + +**`Schema`** + +AdminPostOrderEditsReq +type: object +required: + - order_id +properties: + order_id: + description: The ID of the order to create the edit for. + type: string + internal_note: + description: An optional note to associate with the order edit. + type: string + +## Properties + +### created\_by + +• `Optional` **created\_by**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:77 + +___ + +### internal\_note + +• `Optional` **internal\_note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:76 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/create-order-edit.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md new file mode 100644 index 0000000000..e4edd5b699 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrderEditsRequestConfirmationReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrderEditsRequestConfirmationReq + +## Properties + +### payment\_collection\_description + +• `Optional` **payment\_collection\_description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/request-confirmation.d.ts:53 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md new file mode 100644 index 0000000000..5846ea5d3c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimCancel.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersClaimCancel + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersClaimCancel + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersClaimCancel`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md new file mode 100644 index 0000000000..b17413d584 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersClaimFulfillmentsCancelParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersClaimFulfillmentsCancelParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersClaimFulfillmentsCancelParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md new file mode 100644 index 0000000000..c06091e114 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderArchiveParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderArchiveParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderArchiveParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md new file mode 100644 index 0000000000..c823f9efa4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCancel.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderCancel + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderCancel + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderCancel`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md new file mode 100644 index 0000000000..ad0ad86123 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderCaptureParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderCaptureParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderCaptureParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md new file mode 100644 index 0000000000..41527b3c3c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimFulfillmentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderClaimsClaimFulfillmentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md new file mode 100644 index 0000000000..5eb52cee43 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimFulfillmentsReq + +**`Schema`** + +AdminPostOrdersOrderClaimsClaimFulfillmentsReq +type: object +properties: + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this Claim. + type: boolean + +## Properties + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:86 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:84 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-claim.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md new file mode 100644 index 0000000000..90110a010c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderClaimsClaimParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md new file mode 100644 index 0000000000..8533a1f48d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md @@ -0,0 +1,140 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimReq + +**`Schema`** + +AdminPostOrdersOrderClaimsClaimReq +type: object +properties: + claim_items: + description: The Claim Items that the Claim will consist of. + type: array + items: + type: object + required: + - id + - images + - tags + properties: + id: + description: The ID of the Claim Item. + type: string + item_id: + description: The ID of the Line Item that will be claimed. + type: string + quantity: + description: The number of items that will be returned + type: integer + note: + description: Short text describing the Claim Item in further detail. + type: string + reason: + description: The reason for the Claim + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + tags: + description: A list o tags to add to the Claim Item + type: array + items: + type: object + properties: + id: + type: string + description: Tag ID + value: + type: string + description: Tag value + images: + description: A list of image URL's that will be associated with the Claim + type: array + items: + type: object + properties: + id: + type: string + description: Image ID + url: + type: string + description: Image URL + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + shipping_methods: + description: The Shipping Methods to send the additional Line Items with. + type: array + items: + type: object + properties: + id: + description: The ID of an existing Shipping Method + type: string + option_id: + description: The ID of the Shipping Option to create a Shipping Method from + type: string + price: + description: The price to charge for the Shipping Method + type: integer + data: + description: An optional set of key-value pairs to hold additional information. + type: object + no_notification: + description: If set to true no notification will be send related to this Swap. + type: boolean + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### claim\_items + +• `Optional` **claim\_items**: [`Item`](internal-8.Item-3.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:164 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:167 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:166 + +___ + +### shipping\_methods + +• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-8.ShippingMethod-2.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:165 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md new file mode 100644 index 0000000000..d8acc0a0fb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimShipmentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimShipmentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderClaimsClaimShipmentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md new file mode 100644 index 0000000000..1af51532a5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsClaimShipmentsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsClaimShipmentsReq + +**`Schema`** + +AdminPostOrdersOrderClaimsClaimShipmentsReq +type: object +required: + - fulfillment_id +properties: + fulfillment_id: + description: The ID of the Fulfillment. + type: string + tracking_numbers: + description: An array of tracking numbers for the shipment. + type: array + items: + type: string + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:91 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim-shipment.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md new file mode 100644 index 0000000000..20cb51c4b6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderClaimsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md new file mode 100644 index 0000000000..5a243fd32f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md @@ -0,0 +1,215 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderClaimsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderClaimsReq + +**`Schema`** + +AdminPostOrdersOrderClaimsReq +type: object +required: + - type + - claim_items +properties: + type: + description: "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items." + type: string + enum: + - replace + - refund + claim_items: + description: The Claim Items that the Claim will consist of. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item that will be claimed. + type: string + quantity: + description: The number of items that will be returned + type: integer + note: + description: Short text describing the Claim Item in further detail. + type: string + reason: + description: The reason for the Claim + type: string + enum: + - missing_item + - wrong_item + - production_failure + - other + tags: + description: A list of tags to add to the Claim Item + type: array + items: + type: string + images: + description: A list of image URL's that will be associated with the Claim + items: + type: string + return_shipping: + description: Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim. + type: object + properties: + option_id: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + price: + type: integer + description: The price to charge for the Shipping Method. + additional_items: + description: The new items to send to the Customer. This is only used if the claim's type is `replace`. + type: array + items: + type: object + required: + - variant_id + - quantity + properties: + variant_id: + description: The ID of the Product Variant. + type: string + quantity: + description: The quantity of the Product Variant. + type: integer + shipping_methods: + description: The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`. + type: array + items: + type: object + properties: + id: + description: The ID of an existing Shipping Method + type: string + option_id: + description: The ID of the Shipping Option to create a Shipping Method from + type: string + price: + description: The price to charge for the Shipping Method + type: integer + data: + description: An optional set of key-value pairs to hold additional information. + type: object + shipping_address: + description: "An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used." + $ref: "#/components/schemas/AddressPayload" + refund_amount: + description: The amount to refund the customer. This is used when the claim's type is `refund`. + type: integer + no_notification: + description: If set to true no notification will be send related to this Claim. + type: boolean + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### additional\_items + +• `Optional` **additional\_items**: [`AdditionalItem`](internal-8.AdditionalItem.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:199 + +___ + +### claim\_items + +• **claim\_items**: [`Item`](internal-8.Item-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:197 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:205 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:203 + +___ + +### refund\_amount + +• `Optional` **refund\_amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:201 + +___ + +### return\_location\_id + +• `Optional` **return\_location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:204 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-8.ReturnShipping.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:198 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:202 + +___ + +### shipping\_methods + +• `Optional` **shipping\_methods**: [`ShippingMethod`](internal-8.ShippingMethod-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:200 + +___ + +### type + +• **type**: ``"refund"`` \| ``"replace"`` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-claim.d.ts:196 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md new file mode 100644 index 0000000000..ead08f2230 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderCompleteParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderCompleteParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderCompleteParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md new file mode 100644 index 0000000000..0533c8f82b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderFulfillementsCancelParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderFulfillementsCancelParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderFulfillementsCancelParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md new file mode 100644 index 0000000000..e2fdc3b67a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderFulfillmentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderFulfillmentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderFulfillmentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md new file mode 100644 index 0000000000..9650839fb2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md @@ -0,0 +1,79 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderFulfillmentsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderFulfillmentsReq + +**`Schema`** + +AdminPostOrdersOrderFulfillmentsReq +type: object +required: + - items +properties: + items: + description: The Line Items to include in the Fulfillment. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item to fulfill. + type: string + quantity: + description: The quantity of the Line Item to fulfill. + type: integer + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this fulfillment. + type: boolean + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### items + +• **items**: [`Item`](internal-8.Item-2.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:121 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:122 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:124 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:123 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md new file mode 100644 index 0000000000..1620c0c1b6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md new file mode 100644 index 0000000000..90d6d757dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderRefundsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderRefundsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderRefundsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md new file mode 100644 index 0000000000..dd3db9ebcf --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderRefundsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderRefundsReq + +**`Schema`** + +AdminPostOrdersOrderRefundsReq +type: object +required: + - amount + - reason +properties: + amount: + description: The amount to refund. It should be less than or equal the `refundable_amount` of the order. + type: integer + reason: + description: The reason for the Refund. + type: string + note: + description: A note with additional details about the Refund. + type: string + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this Refund. + type: boolean + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:93 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:96 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:95 + +___ + +### reason + +• **reason**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/refund-payment.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md new file mode 100644 index 0000000000..3f24e75fb4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReq.md @@ -0,0 +1,172 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderReq + +**`Schema`** + +AdminPostOrdersOrderReq +type: object +properties: + email: + description: the email associated with the order + type: string + billing_address: + description: The order's billing address + $ref: "#/components/schemas/AddressPayload" + shipping_address: + description: The order's shipping address + $ref: "#/components/schemas/AddressPayload" + items: + description: The line items of the order + type: array + items: + $ref: "#/components/schemas/LineItem" + region: + description: ID of the region that the order is associated with. + type: string + discounts: + description: The discounts applied to the order + type: array + items: + $ref: "#/components/schemas/Discount" + customer_id: + description: The ID of the customer associated with the order. + type: string + payment_method: + description: The payment method chosen for the order. + type: object + properties: + provider_id: + type: string + description: The ID of the payment provider. + data: + description: Any data relevant for the given payment method. + type: object + shipping_method: + description: The Shipping Method used for shipping the order. + type: object + properties: + provider_id: + type: string + description: The ID of the shipping provider. + profile_id: + type: string + description: The ID of the shipping profile. + price: + type: integer + description: The price of the shipping. + data: + type: object + description: Any data relevant to the specific shipping method. + items: + type: array + items: + $ref: "#/components/schemas/LineItem" + description: Items to ship + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this order. + type: boolean + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:136 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:141 + +___ + +### discounts + +• `Optional` **discounts**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:140 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:135 + +___ + +### items + +• `Optional` **items**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:138 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:144 + +___ + +### payment\_method + +• `Optional` **payment\_method**: [`PaymentMethod`](internal-8.PaymentMethod.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:142 + +___ + +### region + +• `Optional` **region**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:139 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:137 + +___ + +### shipping\_method + +• `Optional` **shipping\_method**: [`ShippingMethod`](internal-8.ShippingMethod-3.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/update-order.d.ts:143 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md new file mode 100644 index 0000000000..166e27773c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderReturnsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderReturnsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderReturnsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md new file mode 100644 index 0000000000..f47a9c7f0c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderReturnsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderReturnsReq + +**`Schema`** + +AdminPostOrdersOrderReturnsReq +type: object +required: + - items +properties: + items: + description: The line items that will be returned. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + reason_id: + description: The ID of the Return Reason to use. + type: string + note: + description: An optional note with information about the Return. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + return_shipping: + description: The Shipping Method to be used to handle the return shipment. + type: object + properties: + option_id: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + price: + type: integer + description: The price to charge for the Shipping Method. + note: + description: An optional note with information about the Return. + type: string + receive_now: + description: A flag to indicate if the Return should be registerd as received immediately. + type: boolean + default: false + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this Return. + type: boolean + refund: + description: The amount to refund. + type: integer + +## Properties + +### items + +• **items**: [`OrdersReturnItem`](internal-8.OrdersReturnItem.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:136 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:142 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:140 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:138 + +___ + +### receive\_now + +• `Optional` **receive\_now**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:139 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:141 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-8.ReturnShipping-2.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/request-return.d.ts:137 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md new file mode 100644 index 0000000000..5416e820b8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShipmentParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderShipmentParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderShipmentParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md new file mode 100644 index 0000000000..9dbb946b06 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShipmentReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderShipmentReq + +**`Schema`** + +AdminPostOrdersOrderShipmentReq +type: object +required: + - fulfillment_id +properties: + fulfillment_id: + description: The ID of the Fulfillment. + type: string + tracking_numbers: + description: The tracking numbers for the shipment. + type: array + items: + type: string + no_notification: + description: If set to true no notification will be send related to this Shipment. + type: boolean + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:93 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:95 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-shipment.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md new file mode 100644 index 0000000000..6ee3e0cbac --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShippingMethodsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderShippingMethodsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderShippingMethodsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md new file mode 100644 index 0000000000..d863e28ace --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderShippingMethodsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderShippingMethodsReq + +**`Schema`** + +AdminPostOrdersOrderShippingMethodsReq +type: object +required: + - price + - option_id +properties: + price: + type: number + description: The price (excluding VAT) that should be charged for the Shipping Method + option_id: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + date: + type: object + description: The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider. + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:92 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:91 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/add-shipping-method.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md new file mode 100644 index 0000000000..f0407f0f29 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapFulfillementsCancelParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapFulfillementsCancelParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderSwapFulfillementsCancelParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md new file mode 100644 index 0000000000..34a9f394de --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderSwapsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md new file mode 100644 index 0000000000..5062b210cf --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md @@ -0,0 +1,165 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsReq + +**`Schema`** + +AdminPostOrdersOrderSwapsReq +type: object +required: + - return_items +properties: + return_items: + description: The Line Items to associate with the swap's return. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item that will be returned. + type: string + quantity: + description: The number of items that will be returned + type: integer + reason_id: + description: The ID of the Return Reason to use. + type: string + note: + description: An optional note with information about the Return. + type: string + return_shipping: + description: The shipping method associated with the swap's return. + type: object + required: + - option_id + properties: + option_id: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + price: + type: integer + description: The price to charge for the Shipping Method. + additional_items: + description: The new items to send to the Customer. + type: array + items: + type: object + required: + - variant_id + - quantity + properties: + variant_id: + description: The ID of the Product Variant. + type: string + quantity: + description: The quantity of the Product Variant. + type: integer + custom_shipping_options: + description: An array of custom shipping options to potentially create a Shipping Method from to send the additional items. + type: array + items: + type: object + required: + - option_id + - price + properties: + option_id: + description: The ID of the Shipping Option. + type: string + price: + description: The custom price of the Shipping Option. + type: integer + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this Swap. + type: boolean + allow_backorder: + description: If set to `true`, swaps can be completed with items out of stock + type: boolean + default: true + +## Properties + +### additional\_items + +• `Optional` **additional\_items**: [`AdditionalItem`](internal-8.AdditionalItem-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:164 + +___ + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:168 + +___ + +### custom\_shipping\_options + +• `Optional` **custom\_shipping\_options**: [`CustomShippingOption`](internal-8.CustomShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:165 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:166 + +___ + +### return\_items + +• **return\_items**: [`ReturnItem`](internal-8.ReturnItem.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:161 + +___ + +### return\_location\_id + +• `Optional` **return\_location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:167 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-8.ReturnShipping-1.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:162 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:163 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md new file mode 100644 index 0000000000..08e6a8ce08 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsSwapFulfillmentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderSwapsSwapFulfillmentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md new file mode 100644 index 0000000000..ae328c5846 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsSwapFulfillmentsReq + +**`Schema`** + +AdminPostOrdersOrderSwapsSwapFulfillmentsReq +type: object +properties: + metadata: + description: An optional set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + no_notification: + description: If set to `true`, no notification will be sent to the customer related to this swap. + type: boolean + +## Properties + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:87 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:85 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/fulfill-swap.d.ts:86 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md new file mode 100644 index 0000000000..d7f88ceef2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapProcessPaymentParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsSwapProcessPaymentParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderSwapsSwapProcessPaymentParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md new file mode 100644 index 0000000000..ffc8a3724b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapShipmentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsSwapShipmentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersOrderSwapsSwapShipmentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md new file mode 100644 index 0000000000..43925a402b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md @@ -0,0 +1,56 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersOrderSwapsSwapShipmentsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersOrderSwapsSwapShipmentsReq + +**`Schema`** + +AdminPostOrdersOrderSwapsSwapShipmentsReq +type: object +required: + - fulfillment_id +properties: + fulfillment_id: + description: The ID of the Fulfillment. + type: string + tracking_numbers: + description: The tracking numbers for the shipment. + type: array + items: + type: string + no_notification: + description: If set to true no notification will be sent related to this Claim. + type: boolean + +## Properties + +### fulfillment\_id + +• **fulfillment\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:94 + +___ + +### no\_notification + +• `Optional` **no\_notification**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:96 + +___ + +### tracking\_numbers + +• `Optional` **tracking\_numbers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-swap-shipment.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md new file mode 100644 index 0000000000..15109f269d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostOrdersSwapCancelParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostOrdersSwapCancelParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostOrdersSwapCancelParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md new file mode 100644 index 0000000000..14018b6f1e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPaymentRefundsReq.md @@ -0,0 +1,55 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPaymentRefundsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPaymentRefundsReq + +**`Schema`** + +AdminPostPaymentRefundsReq +type: object +required: + - amount + - reason +properties: + amount: + description: The amount to refund. + type: integer + reason: + description: The reason for the Refund. + type: string + note: + description: A note with additional details about the Refund. + type: string + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/refund-payment.d.ts:89 + +___ + +### note + +• `Optional` **note**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/refund-payment.d.ts:91 + +___ + +### reason + +• **reason**: [`RefundReason`](../enums/internal-8.internal.RefundReason.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/refund-payment.d.ts:90 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md new file mode 100644 index 0000000000..5ed0ded013 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md @@ -0,0 +1,69 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListPricesPricesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPriceListPricesPricesReq + +**`Schema`** + +AdminPostPriceListPricesPricesReq +type: object +properties: + prices: + description: The prices to update or add. + type: array + items: + type: object + required: + - amount + - variant_id + properties: + id: + description: The ID of the price. + type: string + region_id: + description: The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + variant_id: + description: The ID of the Variant for which the price is used. + type: string + amount: + description: The amount to charge for the Product Variant. + type: integer + min_quantity: + description: The minimum quantity for which the price will be used. + type: integer + max_quantity: + description: The maximum quantity for which the price will be used. + type: integer + override: + description: "If set to `true`, the prices will replace all existing prices associated with the Price List." + type: boolean + +## Properties + +### override + +• `Optional` **override**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:122 + +___ + +### prices + +• **prices**: [`AdminPriceListPricesUpdateReq`](internal-8.internal.AdminPriceListPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/add-prices-batch.d.ts:121 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md new file mode 100644 index 0000000000..46fb819840 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md @@ -0,0 +1,177 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListsPriceListPriceListReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPriceListsPriceListPriceListReq + +**`Schema`** + +AdminPostPriceListsPriceListPriceListReq +type: object +properties: + name: + description: "The name of the Price List" + type: string + description: + description: "The description of the Price List." + type: string + starts_at: + description: "The date with timezone that the Price List starts being valid." + type: string + format: date + ends_at: + description: "The date with timezone that the Price List ends being valid." + type: string + format: date + type: + description: The type of the Price List. + type: string + enum: + - sale + - override + status: + description: "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." + type: string + enum: + - active + - draft + prices: + description: The prices of the Price List. + type: array + items: + type: object + required: + - amount + - variant_id + properties: + id: + description: The ID of the price. + type: string + region_id: + description: The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + variant_id: + description: The ID of the Variant for which the price is used. + type: string + amount: + description: The amount to charge for the Product Variant. + type: integer + min_quantity: + description: The minimum quantity for which the price will be used. + type: integer + max_quantity: + description: The maximum quantity for which the price will be used. + type: integer + customer_groups: + type: array + description: An array of customer groups that the Price List applies to. + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + includes_tax: + description: "Tax included in prices of price list" + x-featureFlag: "tax_inclusive_pricing" + type: boolean + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-8.CustomerGroup-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:157 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:151 + +___ + +### ends\_at + +• `Optional` **ends\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:153 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:158 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:150 + +___ + +### prices + +• `Optional` **prices**: [`AdminPriceListPricesUpdateReq`](internal-8.internal.AdminPriceListPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:156 + +___ + +### starts\_at + +• `Optional` **starts\_at**: ``null`` \| `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:152 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:154 + +___ + +### type + +• `Optional` **type**: [`PriceListType`](../enums/internal-3.PriceListType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/update-price-list.d.ts:155 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md new file mode 100644 index 0000000000..1894b0c8d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPriceListsPriceListReq.md @@ -0,0 +1,179 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPriceListsPriceListReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPriceListsPriceListReq + +**`Schema`** + +AdminPostPriceListsPriceListReq +type: object +required: + - name + - description + - type + - prices +properties: + name: + description: "The name of the Price List." + type: string + description: + description: "The description of the Price List." + type: string + starts_at: + description: "The date with timezone that the Price List starts being valid." + type: string + format: date + ends_at: + description: "The date with timezone that the Price List ends being valid." + type: string + format: date + type: + description: The type of the Price List. + type: string + enum: + - sale + - override + status: + description: "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." + type: string + enum: + - active + - draft + prices: + description: The prices of the Price List. + type: array + items: + type: object + required: + - amount + - variant_id + properties: + region_id: + description: The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + amount: + description: The amount to charge for the Product Variant. + type: integer + variant_id: + description: The ID of the Variant for which the price is used. + type: string + min_quantity: + description: The minimum quantity for which the price will be used. + type: integer + max_quantity: + description: The maximum quantity for which the price will be used. + type: integer + customer_groups: + type: array + description: An array of customer groups that the Price List applies to. + items: + type: object + required: + - id + properties: + id: + description: The ID of a customer group + type: string + includes_tax: + description: "Tax included in prices of price list" + x-featureFlag: "tax_inclusive_pricing" + type: boolean + +## Properties + +### customer\_groups + +• `Optional` **customer\_groups**: [`CustomerGroup`](internal-8.CustomerGroup.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:177 + +___ + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:171 + +___ + +### ends\_at + +• `Optional` **ends\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:173 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:178 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:170 + +___ + +### prices + +• **prices**: [`AdminPriceListPricesCreateReq`](internal-8.internal.AdminPriceListPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:176 + +___ + +### starts\_at + +• `Optional` **starts\_at**: `Date` + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:172 + +___ + +### status + +• `Optional` **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:174 + +___ + +### type + +• **type**: [`PriceListType`](../enums/internal-3.PriceListType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/create-price-list.d.ts:175 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md new file mode 100644 index 0000000000..a0194617c7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesCategoryParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesCategoryParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostProductCategoriesCategoryParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md new file mode 100644 index 0000000000..2a885f75e8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesCategoryProductsBatchParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesCategoryProductsBatchParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostProductCategoriesCategoryProductsBatchParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md new file mode 100644 index 0000000000..f4979817a5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesCategoryProductsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesCategoryProductsBatchReq + +**`Schema`** + +AdminPostProductCategoriesCategoryProductsBatchReq +type: object +required: + - product_ids +properties: + product_ids: + description: The IDs of the products to add to the Product Category + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchProductCategory`](internal-8.ProductBatchProductCategory.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/add-products-batch.d.ts:100 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md new file mode 100644 index 0000000000..2c86fcfd2e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md @@ -0,0 +1,130 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesCategoryReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesCategoryReq + +**`Schema`** + +AdminPostProductCategoriesCategoryReq +type: object +properties: + name: + type: string + description: The name to identify the Product Category by. + description: + type: string + description: An optional text field to describe the Product Category by. + handle: + type: string + description: A handle to be used in slugs. + is_internal: + type: boolean + description: A flag to make product category an internal category for admins + is_active: + type: boolean + description: A flag to make product category visible/hidden in the store front + parent_category_id: + type: string + description: The ID of the parent product category + rank: + type: number + description: The rank of the category in the tree node (starting from 0) + +## Hierarchy + +- [`AdminProductCategoriesReqBase`](internal-8.AdminProductCategoriesReqBase.md) + + ↳ **`AdminPostProductCategoriesCategoryReq`** + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[description](internal-8.AdminProductCategoriesReqBase.md#description) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:18 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Overrides + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[handle](internal-8.AdminProductCategoriesReqBase.md#handle) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/update-product-category.d.ts:101 + +___ + +### is\_active + +• `Optional` **is\_active**: `boolean` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[is_active](internal-8.AdminProductCategoriesReqBase.md#is_active) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:21 + +___ + +### is\_internal + +• `Optional` **is\_internal**: `boolean` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[is_internal](internal-8.AdminProductCategoriesReqBase.md#is_internal) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:20 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/update-product-category.d.ts:100 + +___ + +### parent\_category\_id + +• `Optional` **parent\_category\_id**: ``null`` \| `string` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[parent_category_id](internal-8.AdminProductCategoriesReqBase.md#parent_category_id) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:22 + +___ + +### rank + +• `Optional` **rank**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/update-product-category.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md new file mode 100644 index 0000000000..b919f68c16 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostProductCategoriesParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md new file mode 100644 index 0000000000..fbfac6e6b5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductCategoriesReq.md @@ -0,0 +1,119 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductCategoriesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductCategoriesReq + +**`Schema`** + +AdminPostProductCategoriesReq +type: object +required: + - name +properties: + name: + type: string + description: The name of the product category + description: + type: string + description: The description of the product category. + handle: + type: string + description: The handle of the product category. If none is provided, the kebab-case version of the name will be used. This field can be used as a slug in URLs. + is_internal: + type: boolean + description: If set to `true`, the product category will only be available to admins. + is_active: + type: boolean + description: If set to `false`, the product category will not be available in the storefront. + parent_category_id: + type: string + description: The ID of the parent product category + +## Hierarchy + +- [`AdminProductCategoriesReqBase`](internal-8.AdminProductCategoriesReqBase.md) + + ↳ **`AdminPostProductCategoriesReq`** + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[description](internal-8.AdminProductCategoriesReqBase.md#description) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:18 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[handle](internal-8.AdminProductCategoriesReqBase.md#handle) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:19 + +___ + +### is\_active + +• `Optional` **is\_active**: `boolean` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[is_active](internal-8.AdminProductCategoriesReqBase.md#is_active) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:21 + +___ + +### is\_internal + +• `Optional` **is\_internal**: `boolean` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[is_internal](internal-8.AdminProductCategoriesReqBase.md#is_internal) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:20 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/create-product-category.d.ts:98 + +___ + +### parent\_category\_id + +• `Optional` **parent\_category\_id**: ``null`` \| `string` + +#### Inherited from + +[AdminProductCategoriesReqBase](internal-8.AdminProductCategoriesReqBase.md).[parent_category_id](internal-8.AdminProductCategoriesReqBase.md#parent_category_id) + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md new file mode 100644 index 0000000000..02a1b47f8c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductMetadataReq.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductMetadataReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductMetadataReq + +**`Schema`** + +AdminPostProductsProductMetadataReq +type: object +required: + - key + - value +properties: + key: + description: The metadata key + type: string + value: + description: The metadata value + type: string + +## Properties + +### key + +• **key**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:86 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/set-metadata.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md new file mode 100644 index 0000000000..97781105ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsOption.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductOptionsOption + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductOptionsOption + +**`Schema`** + +AdminPostProductsProductOptionsOption +type: object +required: + - title +properties: + title: + description: "The title of the Product Option" + type: string + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-option.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md new file mode 100644 index 0000000000..5aa6bd7f13 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductOptionsReq.md @@ -0,0 +1,29 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductOptionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductOptionsReq + +**`Schema`** + +AdminPostProductsProductOptionsReq +type: object +required: + - title +properties: + title: + description: "The title the Product Option." + type: string + example: "Size" + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/add-option.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md new file mode 100644 index 0000000000..5982ff44f0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductReq.md @@ -0,0 +1,458 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductReq + +**`Schema`** + +AdminPostProductsProductReq +type: object +properties: + title: + description: "The title of the Product" + type: string + subtitle: + description: "The subtitle of the Product" + type: string + description: + description: "The description of the Product." + type: string + discountable: + description: A flag to indicate if discounts can be applied to the Line Items generated from this Product + type: boolean + images: + description: An array of images of the Product. Each value in the array is a URL to the image. You can use the upload endpoints to upload the image and obtain a URL. + type: array + items: + type: string + thumbnail: + description: The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload endpoints to upload the thumbnail and obtain a URL. + type: string + handle: + description: A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs. + type: string + status: + description: The status of the product. The product is shown to the customer only if its status is `published`. + type: string + enum: [draft, proposed, published, rejected] + type: + description: The Product Type to associate the Product with. + type: object + required: + - value + properties: + id: + description: The ID of an existing Product Type. If not provided, a new product type will be created. + type: string + value: + description: The value of the Product Type. + type: string + collection_id: + description: The ID of the Product Collection the Product belongs to. + type: string + tags: + description: Product Tags to associate the Product with. + type: array + items: + type: object + required: + - value + properties: + id: + description: The ID of an existing Product Tag. If not provided, a new product tag will be created. + type: string + value: + description: The value of the Tag. If the `id` is provided, the value of the existing tag will be updated. + type: string + sales_channels: + description: "Sales channels to associate the Product with." + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of an existing Sales channel. + type: string + categories: + description: "Product categories to add the Product to." + x-featureFlag: "product_categories" + type: array + items: + required: + - id + properties: + id: + description: The ID of a Product Category. + type: string + variants: + description: An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values. + type: array + items: + type: object + properties: + id: + description: The id of an existing product variant. If provided, the details of the product variant will be updated. If not, a new product variant will be created. + type: string + title: + description: The title of the product variant. + type: string + sku: + description: The unique SKU of the product variant. + type: string + ean: + description: The EAN number of the product variant. + type: string + upc: + description: The UPC number of the product variant. + type: string + barcode: + description: A generic GTIN field of the product variant. + type: string + hs_code: + description: The Harmonized System code of the product variant. + type: string + inventory_quantity: + description: The amount of stock kept of the product variant. + type: integer + allow_backorder: + description: Whether the product variant can be purchased when out of stock. + type: boolean + manage_inventory: + description: Whether Medusa should keep track of the inventory of this product variant. + type: boolean + weight: + description: The weight of the product variant. + type: number + length: + description: The length of the product variant. + type: number + height: + description: The height of the product variant. + type: number + width: + description: The width of the product variant. + type: number + origin_country: + description: The country of origin of the product variant. + type: string + mid_code: + description: The Manufacturer Identification code of the product variant. + type: string + material: + description: The material composition of the product variant. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + prices: + type: array + description: An array of product variant prices. A product variant can have different prices for each region or currency code. + externalDocs: + url: https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices + description: Product variant pricing. + items: + type: object + required: + - amount + properties: + id: + description: The ID of the Price. If provided, the existing price will be updated. Otherwise, a new price will be created. + type: string + region_id: + description: The ID of the Region the price will be used in. This is only required if `currency_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + amount: + description: The price amount. + type: integer + min_quantity: + description: The minimum quantity required to be added to the cart for the price to be used. + type: integer + max_quantity: + description: The maximum quantity required to be added to the cart for the price to be used. + type: integer + options: + type: array + description: An array of Product Option values that the variant corresponds to. + items: + type: object + required: + - option_id + - value + properties: + option_id: + description: The ID of the Option. + type: string + value: + description: The value of the Product Option. + type: string + weight: + description: The weight of the Product. + type: number + length: + description: The length of the Product. + type: number + height: + description: The height of the Product. + type: number + width: + description: The width of the Product. + type: number + origin_country: + description: The country of origin of the Product. + type: string + mid_code: + description: The Manufacturer Identification code of the Product. + type: string + material: + description: The material composition of the Product. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### categories + +• `Optional` **categories**: [`ProductProductCategoryReq`](internal-8.ProductProductCategoryReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:328 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:325 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:318 + +___ + +### discountable + +• `Optional` **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:319 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:322 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:332 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:334 + +___ + +### images + +• `Optional` **images**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:320 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:331 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:337 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:338 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:336 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:335 + +___ + +### sales\_channels + +• `Optional` **sales\_channels**: ``null`` \| [`ProductSalesChannelReq`](internal-8.ProductSalesChannelReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:327 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:323 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:317 + +___ + +### tags + +• `Optional` **tags**: [`ProductTagReq`](internal-8.ProductTagReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:326 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:321 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:316 + +___ + +### type + +• `Optional` **type**: [`ProductTypeReq`](internal-8.ProductTypeReq.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:324 + +___ + +### variants + +• `Optional` **variants**: [`ProductVariantReq`](internal-8.ProductVariantReq-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:329 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:330 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-product.d.ts:333 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md new file mode 100644 index 0000000000..0e21cd234a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsReq.md @@ -0,0 +1,307 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductVariantsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductVariantsReq + +**`Schema`** + +AdminPostProductsProductVariantsReq +type: object +required: + - title + - prices + - options +properties: + title: + description: The title of the product variant. + type: string + sku: + description: The unique SKU of the product variant. + type: string + ean: + description: The EAN number of the product variant. + type: string + upc: + description: The UPC number of the product variant. + type: string + barcode: + description: A generic GTIN field of the product variant. + type: string + hs_code: + description: The Harmonized System code of the product variant. + type: string + inventory_quantity: + description: The amount of stock kept of the product variant. + type: integer + default: 0 + allow_backorder: + description: Whether the product variant can be purchased when out of stock. + type: boolean + manage_inventory: + description: Whether Medusa should keep track of the inventory of this product variant. + type: boolean + default: true + weight: + description: The wieght of the product variant. + type: number + length: + description: The length of the product variant. + type: number + height: + description: The height of the product variant. + type: number + width: + description: The width of the product variant. + type: number + origin_country: + description: The country of origin of the product variant. + type: string + mid_code: + description: The Manufacturer Identification code of the product variant. + type: string + material: + description: The material composition of the product variant. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + prices: + type: array + description: An array of product variant prices. A product variant can have different prices for each region or currency code. + externalDocs: + url: https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices + description: Product variant pricing. + items: + type: object + required: + - amount + properties: + region_id: + description: The ID of the Region the price will be used in. This is only required if `currency_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + amount: + description: The price amount. + type: integer + min_quantity: + description: The minimum quantity required to be added to the cart for the price to be used. + type: integer + max_quantity: + description: The maximum quantity required to be added to the cart for the price to be used. + type: integer + options: + type: array + description: An array of Product Option values that the variant corresponds to. + items: + type: object + required: + - option_id + - value + properties: + option_id: + description: The ID of the Product Option. + type: string + value: + description: A value to give to the Product Option. + type: string + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:213 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:210 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:208 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:217 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:211 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:212 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:216 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:214 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:221 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:222 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:220 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-8.ProductVariantOptionReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:224 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:219 + +___ + +### prices + +• **prices**: [`ProductVariantPricesCreateReq`](internal-8.ProductVariantPricesCreateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:223 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:207 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:206 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:209 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:215 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-variant.d.ts:218 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md new file mode 100644 index 0000000000..f7e2b44f23 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md @@ -0,0 +1,304 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsProductVariantsVariantReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsProductVariantsVariantReq + +**`Schema`** + +AdminPostProductsProductVariantsVariantReq +type: object +properties: + title: + description: The title of the product variant. + type: string + sku: + description: The unique SKU of the product variant. + type: string + ean: + description: The EAN number of the item. + type: string + upc: + description: The UPC number of the item. + type: string + barcode: + description: A generic GTIN field of the product variant. + type: string + hs_code: + description: The Harmonized System code of the product variant. + type: string + inventory_quantity: + description: The amount of stock kept of the product variant. + type: integer + allow_backorder: + description: Whether the product variant can be purchased when out of stock. + type: boolean + manage_inventory: + description: Whether Medusa should keep track of the inventory of this product variant. + type: boolean + weight: + description: The weight of the product variant. + type: number + length: + description: The length of the product variant. + type: number + height: + description: The height of the product variant. + type: number + width: + description: The width of the product variant. + type: number + origin_country: + description: The country of origin of the product variant. + type: string + mid_code: + description: The Manufacturer Identification code of the product variant. + type: string + material: + description: The material composition of the product variant. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + prices: + type: array + description: An array of product variant prices. A product variant can have different prices for each region or currency code. + externalDocs: + url: https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices + description: Product variant pricing. + items: + type: object + required: + - amount + properties: + id: + description: The ID of the price. If provided, the existing price will be updated. Otherwise, a new price will be created. + type: string + region_id: + description: The ID of the Region the price will be used in. This is only required if `currency_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + amount: + description: The price amount. + type: integer + min_quantity: + description: The minimum quantity required to be added to the cart for the price to be used. + type: integer + max_quantity: + description: The maximum quantity required to be added to the cart for the price to be used. + type: integer + options: + type: array + description: An array of Product Option values that the variant corresponds to. + items: + type: object + required: + - option_id + - value + properties: + option_id: + description: The ID of the Product Option. + type: string + value: + description: The value of the Product Option. + type: string + +## Properties + +### allow\_backorder + +• `Optional` **allow\_backorder**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:205 + +___ + +### barcode + +• `Optional` **barcode**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:202 + +___ + +### ean + +• `Optional` **ean**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:200 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:209 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:203 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:204 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:208 + +___ + +### manage\_inventory + +• `Optional` **manage\_inventory**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:206 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:213 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:214 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:212 + +___ + +### options + +• `Optional` **options**: [`ProductVariantOptionReq`](internal-8.ProductVariantOptionReq-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:216 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:211 + +___ + +### prices + +• `Optional` **prices**: [`ProductVariantPricesUpdateReq`](internal-8.ProductVariantPricesUpdateReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:215 + +___ + +### sku + +• `Optional` **sku**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:199 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:198 + +___ + +### upc + +• `Optional` **upc**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:201 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:207 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/update-variant.d.ts:210 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md new file mode 100644 index 0000000000..77862029d5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostProductsReq.md @@ -0,0 +1,497 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostProductsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostProductsReq + +**`Schema`** + +AdminPostProductsReq +type: object +required: + - title +properties: + title: + description: "The title of the Product" + type: string + subtitle: + description: "The subtitle of the Product" + type: string + description: + description: "The description of the Product." + type: string + is_giftcard: + description: A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to `true` will result in a Gift Card being created. + type: boolean + default: false + discountable: + description: A flag to indicate if discounts can be applied to the Line Items generated from this Product + type: boolean + default: true + images: + description: An array of images of the Product. Each value in the array is a URL to the image. You can use the upload endpoints to upload the image and obtain a URL. + type: array + items: + type: string + thumbnail: + description: The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload endpoints to upload the thumbnail and obtain a URL. + type: string + handle: + description: A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs. + type: string + status: + description: The status of the product. The product is shown to the customer only if its status is `published`. + type: string + enum: [draft, proposed, published, rejected] + default: draft + type: + description: The Product Type to associate the Product with. + type: object + required: + - value + properties: + id: + description: The ID of an existing Product Type. If not provided, a new product type will be created. + type: string + value: + description: The value of the Product Type. + type: string + collection_id: + description: The ID of the Product Collection the Product belongs to. + type: string + tags: + description: Product Tags to associate the Product with. + type: array + items: + type: object + required: + - value + properties: + id: + description: The ID of an existing Product Tag. If not provided, a new product tag will be created. + type: string + value: + description: The value of the Tag. If the `id` is provided, the value of the existing tag will be updated. + type: string + sales_channels: + description: "Sales channels to associate the Product with." + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of an existing Sales channel. + type: string + categories: + description: "Product categories to add the Product to." + x-featureFlag: "product_categories" + type: array + items: + type: object + required: + - id + properties: + id: + description: The ID of a Product Category. + type: string + options: + description: The Options that the Product should have. A new product option will be created for every item in the array. + type: array + items: + type: object + required: + - title + properties: + title: + description: The title of the Product Option. + type: string + variants: + description: An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values. + type: array + items: + type: object + required: + - title + properties: + title: + description: The title of the Product Variant. + type: string + sku: + description: The unique SKU of the Product Variant. + type: string + ean: + description: The EAN number of the item. + type: string + upc: + description: The UPC number of the item. + type: string + barcode: + description: A generic GTIN field of the Product Variant. + type: string + hs_code: + description: The Harmonized System code of the Product Variant. + type: string + inventory_quantity: + description: The amount of stock kept of the Product Variant. + type: integer + default: 0 + allow_backorder: + description: Whether the Product Variant can be purchased when out of stock. + type: boolean + manage_inventory: + description: Whether Medusa should keep track of the inventory of this Product Variant. + type: boolean + weight: + description: The wieght of the Product Variant. + type: number + length: + description: The length of the Product Variant. + type: number + height: + description: The height of the Product Variant. + type: number + width: + description: The width of the Product Variant. + type: number + origin_country: + description: The country of origin of the Product Variant. + type: string + mid_code: + description: The Manufacturer Identification code of the Product Variant. + type: string + material: + description: The material composition of the Product Variant. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + prices: + type: array + description: An array of product variant prices. A product variant can have different prices for each region or currency code. + externalDocs: + url: https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices + description: Product variant pricing. + items: + type: object + required: + - amount + properties: + region_id: + description: The ID of the Region the price will be used in. This is only required if `currency_code` is not provided. + type: string + currency_code: + description: The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided. + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + amount: + description: The price amount. + type: integer + min_quantity: + description: The minimum quantity required to be added to the cart for the price to be used. + type: integer + max_quantity: + description: The maximum quantity required to be added to the cart for the price to be used. + type: integer + options: + type: array + description: An array of Product Option values that the variant corresponds to. The option values should be added into the array in the same index as in the `options` field of the product. + externalDocs: + url: https://docs.medusajs.com/modules/products/admin/manage-products#create-a-product + description: Example of how to create a product with options and variants + items: + type: object + required: + - value + properties: + value: + description: The value to give for the Product Option at the same index in the Product's `options` field. + type: string + weight: + description: The weight of the Product. + type: number + length: + description: The length of the Product. + type: number + height: + description: The height of the Product. + type: number + width: + description: The width of the Product. + type: number + hs_code: + description: The Harmonized System code of the Product. + type: string + origin_country: + description: The country of origin of the Product. + type: string + mid_code: + description: The Manufacturer Identification code of the Product. + type: string + material: + description: The material composition of the Product. + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### categories + +• `Optional` **categories**: [`ProductProductCategoryReq`](internal-8.ProductProductCategoryReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:349 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:346 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:338 + +___ + +### discountable + +• **discountable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:340 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:343 + +___ + +### height + +• `Optional` **height**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:354 + +___ + +### hs\_code + +• `Optional` **hs\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:356 + +___ + +### images + +• `Optional` **images**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:341 + +___ + +### is\_giftcard + +• **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:339 + +___ + +### length + +• `Optional` **length**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:353 + +___ + +### material + +• `Optional` **material**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:359 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:360 + +___ + +### mid\_code + +• `Optional` **mid\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:358 + +___ + +### options + +• `Optional` **options**: [`ProductOptionReq`](internal-8.ProductOptionReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:350 + +___ + +### origin\_country + +• `Optional` **origin\_country**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:357 + +___ + +### sales\_channels + +• `Optional` **sales\_channels**: [`ProductSalesChannelReq`](internal-8.ProductSalesChannelReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:348 + +___ + +### status + +• `Optional` **status**: [`ProductStatus`](../enums/internal-3.ProductStatus.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:344 + +___ + +### subtitle + +• `Optional` **subtitle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:337 + +___ + +### tags + +• `Optional` **tags**: [`ProductTagReq`](internal-8.ProductTagReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:347 + +___ + +### thumbnail + +• `Optional` **thumbnail**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:342 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:336 + +___ + +### type + +• `Optional` **type**: [`ProductTypeReq`](internal-8.ProductTypeReq.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:345 + +___ + +### variants + +• `Optional` **variants**: [`ProductVariantReq`](internal-8.ProductVariantReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:351 + +___ + +### weight + +• `Optional` **weight**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:352 + +___ + +### width + +• `Optional` **width**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/create-product.d.ts:355 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md new file mode 100644 index 0000000000..19c3083ac1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPublishableApiKeySalesChannelsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPublishableApiKeySalesChannelsBatchReq + +**`Schema`** + +AdminPostPublishableApiKeySalesChannelsBatchReq +type: object +required: + - sales_channel_ids +properties: + sales_channel_ids: + description: The IDs of the sales channels to add to the publishable API key + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the sales channel + +## Properties + +### sales\_channel\_ids + +• **sales\_channel\_ids**: [`ProductBatchSalesChannel`](internal-8.ProductBatchSalesChannel.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/add-channels-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md new file mode 100644 index 0000000000..29052d5baf --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPublishableApiKeysPublishableApiKeyReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPublishableApiKeysPublishableApiKeyReq + +**`Schema`** + +AdminPostPublishableApiKeysPublishableApiKeyReq +type: object +properties: + title: + description: The title of the Publishable API Key. + type: string + +## Properties + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/update-publishable-api-key.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md new file mode 100644 index 0000000000..ac7c4c3b37 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostPublishableApiKeysReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostPublishableApiKeysReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostPublishableApiKeysReq + +**`Schema`** + +AdminPostPublishableApiKeysReq +type: object +required: + - title +properties: + title: + description: The title of the publishable API key + type: string + +## Properties + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/create-publishable-api-key.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md new file mode 100644 index 0000000000..c64c8eaef7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md @@ -0,0 +1,31 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionCountriesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostRegionsRegionCountriesReq + +**`Schema`** + +AdminPostRegionsRegionCountriesReq +type: object +required: + - country_code +properties: + country_code: + description: "The 2 character ISO code for the Country." + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + +## Properties + +### country\_code + +• **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-country.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md new file mode 100644 index 0000000000..0f2fa0543f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionFulfillmentProvidersReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostRegionsRegionFulfillmentProvidersReq + +**`Schema`** + +AdminPostRegionsRegionFulfillmentProvidersReq +type: object +required: + - provider_id +properties: + provider_id: + description: "The ID of the Fulfillment Provider." + type: string + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-fulfillment-provider.d.ts:77 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md new file mode 100644 index 0000000000..f58461c30c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionPaymentProvidersReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostRegionsRegionPaymentProvidersReq + +**`Schema`** + +AdminPostRegionsRegionPaymentProvidersReq +type: object +required: + - provider_id +properties: + provider_id: + description: "The ID of the Payment Provider." + type: string + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/add-payment-provider.d.ts:77 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md new file mode 100644 index 0000000000..671dbfa96e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsRegionReq.md @@ -0,0 +1,179 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsRegionReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostRegionsRegionReq + +**`Schema`** + +AdminPostRegionsRegionReq +type: object +properties: + name: + description: "The name of the Region" + type: string + currency_code: + description: "The 3 character ISO currency code to use in the Region." + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + automatic_taxes: + description: "If set to `true`, the Medusa backend will automatically calculate taxes for carts in this region. If set to `false`, the taxes must be calculated manually." + externalDocs: + url: https://docs.medusajs.com/modules/taxes/storefront/manual-calculation + description: How to calculate taxes in a storefront. + type: boolean + gift_cards_taxable: + description: "If set to `true`, taxes will be applied on gift cards." + type: boolean + tax_provider_id: + description: "The ID of the tax provider to use. If none provided, the system tax provider is used." + type: string + tax_code: + description: "The tax code of the Region." + type: string + tax_rate: + description: "The tax rate to use in the Region." + type: number + includes_tax: + x-featureFlag: "tax_inclusive_pricing" + description: "Whether taxes are included in the prices of the region." + type: boolean + payment_providers: + description: "A list of Payment Provider IDs that can be used in the Region" + type: array + items: + type: string + fulfillment_providers: + description: "A list of Fulfillment Provider IDs that can be used in the Region" + type: array + items: + type: string + countries: + description: "A list of countries' 2 ISO characters that should be included in the Region." + type: array + items: + type: string + +## Properties + +### automatic\_taxes + +• `Optional` **automatic\_taxes**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:123 + +___ + +### countries + +• `Optional` **countries**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:127 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:119 + +___ + +### fulfillment\_providers + +• `Optional` **fulfillment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:126 + +___ + +### gift\_cards\_taxable + +• `Optional` **gift\_cards\_taxable**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:122 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:128 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:129 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:118 + +___ + +### payment\_providers + +• `Optional` **payment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:125 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:120 + +___ + +### tax\_provider\_id + +• `Optional` **tax\_provider\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:124 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/update-region.d.ts:121 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md new file mode 100644 index 0000000000..e34f2723e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostRegionsReq.md @@ -0,0 +1,145 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostRegionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostRegionsReq + +**`Schema`** + +AdminPostRegionsReq +type: object +required: + - name + - currency_code + - tax_rate + - payment_providers + - fulfillment_providers + - countries +properties: + name: + description: "The name of the Region" + type: string + currency_code: + description: "The 3 character ISO currency code to use in the Region." + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + tax_code: + description: "The tax code of the Region." + type: string + tax_rate: + description: "The tax rate to use in the Region." + type: number + payment_providers: + description: "A list of Payment Provider IDs that can be used in the Region" + type: array + items: + type: string + fulfillment_providers: + description: "A list of Fulfillment Provider IDs that can be used in the Region" + type: array + items: + type: string + countries: + description: "A list of countries' 2 ISO characters that should be included in the Region." + example: ["US"] + type: array + items: + type: string + includes_tax: + x-featureFlag: "tax_inclusive_pricing" + description: "Whether taxes are included in the prices of the region." + type: boolean + +## Properties + +### countries + +• **countries**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:140 + +___ + +### currency\_code + +• **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:135 + +___ + +### fulfillment\_providers + +• **fulfillment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:139 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:141 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:142 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:134 + +___ + +### payment\_providers + +• **payment\_providers**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:138 + +___ + +### tax\_code + +• `Optional` **tax\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:136 + +___ + +### tax\_rate + +• **tax\_rate**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/create-region.d.ts:137 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md new file mode 100644 index 0000000000..492a9363c8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReq.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReservationsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostReservationsReq + +**`Schema`** + +AdminPostReservationsReq +type: object +required: + - location_id + - inventory_item_id + - quantity +properties: + line_item_id: + description: "The ID of the line item of the reservation." + type: string + location_id: + description: "The ID of the location of the reservation." + type: string + inventory_item_id: + description: "The ID of the inventory item the reservation is associated with." + type: string + quantity: + description: "The quantity to reserve." + type: number + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:100 + +___ + +### inventory\_item\_id + +• **inventory\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:98 + +___ + +### line\_item\_id + +• `Optional` **line\_item\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:96 + +___ + +### location\_id + +• **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:97 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:101 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/create-reservation.d.ts:99 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md new file mode 100644 index 0000000000..4a72547b76 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReservationsReservationReq.md @@ -0,0 +1,65 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReservationsReservationReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostReservationsReservationReq + +**`Schema`** + +AdminPostReservationsReservationReq +type: object +properties: + location_id: + description: "The ID of the location associated with the reservation." + type: string + quantity: + description: "The quantity to reserve." + type: number + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts:84 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts:83 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts:85 + +___ + +### quantity + +• `Optional` **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/update-reservation.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md new file mode 100644 index 0000000000..b9225d46ba --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnReasonsReasonReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostReturnReasonsReasonReq + +**`Schema`** + +AdminPostReturnReasonsReasonReq +type: object +properties: + label: + description: "The label to display to the Customer." + type: string + value: + description: "A unique value of the return reason." + type: string + description: + description: "The description of the Reason." + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:89 + +___ + +### label + +• `Optional` **label**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:87 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:90 + +___ + +### value + +• `Optional` **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/update-reason.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md new file mode 100644 index 0000000000..6eefc9af47 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnReasonsReq.md @@ -0,0 +1,84 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnReasonsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostReturnReasonsReq + +**`Schema`** + +AdminPostReturnReasonsReq +type: object +required: + - label + - value +properties: + label: + description: "The label to display to the Customer." + type: string + value: + description: "A unique value of the return reason." + type: string + parent_return_reason_id: + description: "The ID of the parent return reason." + type: string + description: + description: "The description of the Reason." + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:96 + +___ + +### label + +• **label**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:94 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:97 + +___ + +### parent\_return\_reason\_id + +• `Optional` **parent\_return\_reason\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:95 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/create-reason.d.ts:93 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md new file mode 100644 index 0000000000..18198f998f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostReturnsReturnReceiveReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostReturnsReturnReceiveReq + +**`Schema`** + +AdminPostReturnsReturnReceiveReq +type: object +required: + - items +properties: + items: + description: The Line Items that have been received. + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the Line Item. + type: string + quantity: + description: The quantity of the Line Item. + type: integer + refund: + description: The amount to refund. + type: number + +## Properties + +### items + +• **items**: [`Item`](internal-8.Item-4.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:105 + +___ + +### location\_id + +• `Optional` **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:107 + +___ + +### refund + +• `Optional` **refund**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/receive-return.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md new file mode 100644 index 0000000000..3cdb30304a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md @@ -0,0 +1,36 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostSalesChannelsChannelProductsBatchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostSalesChannelsChannelProductsBatchReq + +**`Schema`** + +AdminPostSalesChannelsChannelProductsBatchReq +type: object +required: + - product_ids +properties: + product_ids: + description: The IDs of the products to add to the Sales Channel + type: array + items: + type: object + required: + - id + properties: + id: + type: string + description: The ID of the product + +## Properties + +### product\_ids + +• **product\_ids**: [`ProductBatchSalesChannel`](internal-8.ProductBatchSalesChannel.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/add-product-batch.d.ts:95 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md new file mode 100644 index 0000000000..5c6ee9dc1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostSalesChannelsChannelStockLocationsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostSalesChannelsChannelStockLocationsReq + +**`Schema`** + +AdminPostSalesChannelsChannelStockLocationsReq +type: object +required: + - location_id +properties: + location_id: + description: The ID of the stock location + type: string + +## Properties + +### location\_id + +• **location\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/associate-stock-location.d.ts:78 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md new file mode 100644 index 0000000000..7b3fe51116 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsReq.md @@ -0,0 +1,54 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostSalesChannelsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostSalesChannelsReq + +**`Schema`** + +AdminPostSalesChannelsReq +type: object +required: + - name +properties: + name: + description: The name of the Sales Channel + type: string + description: + description: The description of the Sales Channel + type: string + is_disabled: + description: Whether the Sales Channel is disabled. + type: boolean + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:84 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:85 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/create-sales-channel.d.ts:83 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md new file mode 100644 index 0000000000..620b48a96c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md @@ -0,0 +1,52 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostSalesChannelsSalesChannelReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostSalesChannelsSalesChannelReq + +**`Schema`** + +AdminPostSalesChannelsSalesChannelReq +type: object +properties: + name: + type: string + description: The name of the sales channel + description: + type: string + description: The description of the sales channel. + is_disabled: + type: boolean + description: Whether the Sales Channel is disabled. + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:83 + +___ + +### is\_disabled + +• `Optional` **is\_disabled**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:84 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/update-sales-channel.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md new file mode 100644 index 0000000000..41b0e2434d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md @@ -0,0 +1,115 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingOptionsOptionReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostShippingOptionsOptionReq + +**`Schema`** + +AdminPostShippingOptionsOptionReq +type: object +required: + - requirements +properties: + name: + description: "The name of the Shipping Option" + type: string + amount: + description: "The amount to charge for the Shipping Option. If the `price_type` of the shipping option is `calculated`, this amount will not actually be used." + type: integer + admin_only: + description: If set to `true`, the shipping option can only be used when creating draft orders. + type: boolean + metadata: + description: "An optional set of key-value pairs with additional information." + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + requirements: + description: "The requirements that must be satisfied for the Shipping Option to be available." + type: array + items: + type: object + required: + - type + - amount + properties: + id: + description: The ID of an existing requirement. If an ID is passed, the existing requirement's details are updated. Otherwise, a new requirement is created. + type: string + type: + description: The type of the requirement + type: string + enum: + - max_subtotal + - min_subtotal + amount: + description: The amount to compare with. + type: integer + includes_tax: + description: "Tax included in prices of shipping option" + x-featureFlag: "tax_inclusive_pricing" + type: boolean + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:134 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:132 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:136 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:135 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:131 + +___ + +### requirements + +• **requirements**: [`OptionRequirement`](internal-8.OptionRequirement-1.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:133 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md new file mode 100644 index 0000000000..381d9d8456 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsReq.md @@ -0,0 +1,199 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingOptionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostShippingOptionsReq + +**`Schema`** + +AdminPostShippingOptionsReq +type: object +required: + - name + - region_id + - provider_id + - data + - price_type +properties: + name: + description: "The name of the Shipping Option" + type: string + region_id: + description: "The ID of the Region in which the Shipping Option will be available." + type: string + provider_id: + description: "The ID of the Fulfillment Provider that handles the Shipping Option." + type: string + profile_id: + description: "The ID of the Shipping Profile to add the Shipping Option to." + type: number + data: + description: "The data needed for the Fulfillment Provider to handle shipping with this Shipping Option." + type: object + price_type: + description: "The type of the Shipping Option price. `flat_rate` indicates fixed pricing, whereas `calculated` indicates that the price will be calculated each time by the fulfillment provider." + type: string + enum: + - flat_rate + - calculated + amount: + description: "The amount to charge for the Shipping Option. If the `price_type` is set to `calculated`, this amount will not actually be used." + type: integer + requirements: + description: "The requirements that must be satisfied for the Shipping Option to be available." + type: array + items: + type: object + required: + - type + - amount + properties: + type: + description: The type of the requirement + type: string + enum: + - max_subtotal + - min_subtotal + amount: + description: The amount to compare with. + type: integer + is_return: + description: Whether the Shipping Option can be used for returns or during checkout. + type: boolean + default: false + admin_only: + description: If set to `true`, the shipping option can only be used when creating draft orders. + type: boolean + default: false + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + includes_tax: + description: "Tax included in prices of shipping option" + x-featureFlag: "tax_inclusive_pricing" + type: boolean + +## Properties + +### admin\_only + +• `Optional` **admin\_only**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:157 + +___ + +### amount + +• `Optional` **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:155 + +___ + +### data + +• **data**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:153 + +___ + +### includes\_tax + +• `Optional` **includes\_tax**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:160 + +___ + +### is\_return + +• `Optional` **is\_return**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:158 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:159 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:149 + +___ + +### price\_type + +• **price\_type**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:154 + +___ + +### profile\_id + +• `Optional` **profile\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:152 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:151 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:150 + +___ + +### requirements + +• `Optional` **requirements**: [`OptionRequirement`](internal-8.OptionRequirement.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/create-shipping-option.d.ts:156 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md new file mode 100644 index 0000000000..45475d38a9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingProfilesProfileReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostShippingProfilesProfileReq + +**`Schema`** + +AdminPostShippingProfilesProfileReq +type: object +properties: + name: + description: The name of the Shipping Profile + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + type: + description: The type of the Shipping Profile + type: string + enum: [default, gift_card, custom] + products: + description: product IDs to associate with the Shipping Profile + type: array + shipping_options: + description: Shipping option IDs to associate with the Shipping Profile + type: array + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:92 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:91 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:94 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:95 + +___ + +### type + +• `Optional` **type**: [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:93 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md new file mode 100644 index 0000000000..d8d299b8c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesReq.md @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostShippingProfilesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostShippingProfilesReq + +**`Schema`** + +AdminPostShippingProfilesReq +type: object +required: + - name + - type +properties: + name: + description: The name of the Shipping Profile + type: string + type: + description: The type of the Shipping Profile + type: string + enum: [default, gift_card, custom] + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:83 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:81 + +___ + +### type + +• **type**: [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/create-shipping-profile.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md new file mode 100644 index 0000000000..69b05285f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStockLocationsLocationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostStockLocationsLocationParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostStockLocationsLocationParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md new file mode 100644 index 0000000000..a0822b5dc6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsLocationReq.md @@ -0,0 +1,68 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStockLocationsLocationReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostStockLocationsLocationReq + +**`Schema`** + +AdminPostStockLocationsLocationReq +type: object +properties: + name: + description: the name of the stock location + type: string + address_id: + description: the stock location address ID + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + address: + $ref: "#/components/schemas/StockLocationAddressInput" + +## Properties + +### address + +• `Optional` **address**: [`StockLocationAddress`](internal-8.StockLocationAddress-1.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:102 + +___ + +### address\_id + +• `Optional` **address\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:103 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:104 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/update-stock-location.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md new file mode 100644 index 0000000000..4c6c741da8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStockLocationsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostStockLocationsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`AdminPostStockLocationsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md new file mode 100644 index 0000000000..a8f874366a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.md @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStockLocationsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostStockLocationsReq + +**`Schema`** + +AdminPostStockLocationsReq +type: object +required: + - name +properties: + name: + description: the name of the stock location + type: string + address_id: + description: the ID of an existing stock location address to associate with the stock location. Only required if `address` is not provided. + type: string + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + address: + description: A new stock location address to create and associate with the stock location. Only required if `address_id` is not provided. + $ref: "#/components/schemas/StockLocationAddressInput" + +## Properties + +### address + +• `Optional` **address**: [`StockLocationAddress`](internal-8.StockLocationAddress.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:145 + +___ + +### address\_id + +• `Optional` **address\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:146 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:147 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:144 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md new file mode 100644 index 0000000000..0c6ae2a98b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStoreReq.md @@ -0,0 +1,118 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostStoreReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostStoreReq + +**`Schema`** + +AdminPostStoreReq +type: object +properties: + name: + description: "The name of the Store" + type: string + swap_link_template: + description: "A template for Swap links - use `{{cart_id}}` to insert the Swap Cart ID" + type: string + example: "http://example.com/swaps/{{cart_id}}" + payment_link_template: + description: "A template for payment links - use `{{cart_id}}` to insert the Cart ID" + example: "http://example.com/payments/{{cart_id}}" + type: string + invite_link_template: + description: "A template for invite links - use `{{invite_token}}` to insert the invite token" + example: "http://example.com/invite?token={{invite_token}}" + type: string + default_currency_code: + description: "The default currency code of the Store." + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + currencies: + description: "Array of available currencies in the store. Each currency is in 3 character ISO code format." + type: array + items: + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes + description: See a list of codes. + metadata: + description: "An optional set of key-value pairs with additional information." + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### currencies + +• `Optional` **currencies**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:110 + +___ + +### default\_currency\_code + +• `Optional` **default\_currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:109 + +___ + +### invite\_link\_template + +• `Optional` **invite\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:108 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:111 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:105 + +___ + +### payment\_link\_template + +• `Optional` **payment\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:107 + +___ + +### swap\_link\_template + +• `Optional` **swap\_link\_template**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/update-store.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md new file mode 100644 index 0000000000..ae5854953f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:134 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:135 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md new file mode 100644 index 0000000000..7fb8b837e1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesReq.md @@ -0,0 +1,114 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesReq + +**`Schema`** + +AdminPostTaxRatesReq +type: object +required: + - code + - name + - region_id +properties: + code: + type: string + description: "The code of the tax rate." + name: + type: string + description: "The name of the tax rate." + region_id: + type: string + description: "The ID of the Region that the tax rate belongs to." + rate: + type: number + description: "The numeric rate to charge." + products: + type: array + description: "The IDs of the products associated with this tax rate." + items: + type: string + shipping_options: + type: array + description: "The IDs of the shipping options associated with this tax rate" + items: + type: string + product_types: + type: array + description: "The IDs of the types of products associated with this tax rate" + items: + type: string + +## Properties + +### code + +• **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:125 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:126 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:131 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:129 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:128 + +___ + +### region\_id + +• **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:127 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/create-tax-rate.d.ts:130 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md new file mode 100644 index 0000000000..235db9282b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:127 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:128 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md new file mode 100644 index 0000000000..9817c06796 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductTypesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateProductTypesParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md new file mode 100644 index 0000000000..bf97707a10 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductTypesReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateProductTypesReq + +**`Schema`** + +AdminPostTaxRatesTaxRateProductTypesReq +type: object +required: + - product_types +properties: + product_types: + type: array + description: "The IDs of the types of products to associate with this tax rate" + items: + type: string + +## Properties + +### product\_types + +• **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-product-types.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md new file mode 100644 index 0000000000..5d484a7312 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateProductsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md new file mode 100644 index 0000000000..a751a42241 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateProductsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateProductsReq + +**`Schema`** + +AdminPostTaxRatesTaxRateProductsReq +type: object +required: + - products +properties: + products: + type: array + description: "The IDs of the products to associate with this tax rate" + items: + type: string + +## Properties + +### products + +• **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-products.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md new file mode 100644 index 0000000000..41b37c9b96 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md @@ -0,0 +1,110 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateReq + +**`Schema`** + +AdminPostTaxRatesTaxRateReq +type: object +properties: + code: + type: string + description: "The code of the tax rate." + name: + type: string + description: "The name of the tax rate." + region_id: + type: string + description: "The ID of the Region that the tax rate belongs to." + rate: + type: number + description: "The numeric rate to charge." + products: + type: array + description: "The IDs of the products associated with this tax rate" + items: + type: string + shipping_options: + type: array + description: "The IDs of the shipping options associated with this tax rate" + items: + type: string + product_types: + type: array + description: "The IDs of the types of product types associated with this tax rate" + items: + type: string + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:118 + +___ + +### name + +• `Optional` **name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:119 + +___ + +### product\_types + +• `Optional` **product\_types**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:124 + +___ + +### products + +• `Optional` **products**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:122 + +___ + +### rate + +• `Optional` **rate**: ``null`` \| `number` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:121 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:120 + +___ + +### shipping\_options + +• `Optional` **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/update-tax-rate.d.ts:123 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md new file mode 100644 index 0000000000..e4702de7b6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateShippingOptionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateShippingOptionsParams + +## Properties + +### expand + +• `Optional` **expand**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:105 + +___ + +### fields + +• `Optional` **fields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md new file mode 100644 index 0000000000..e735f45e4b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostTaxRatesTaxRateShippingOptionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostTaxRatesTaxRateShippingOptionsReq + +**`Schema`** + +AdminPostTaxRatesTaxRateShippingOptionsReq +type: object +required: + - shipping_options +properties: + shipping_options: + type: array + description: "The IDs of the shipping options to associate with this tax rate" + items: + type: string + +## Properties + +### shipping\_options + +• **shipping\_options**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/add-to-shipping-options.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md new file mode 100644 index 0000000000..5eb1b535e4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminPostUploadsDownloadUrlReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPostUploadsDownloadUrlReq + +**`Schema`** + +AdminPostUploadsDownloadUrlReq +type: object +required: + - file_key +properties: + file_key: + description: "key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly." + type: string + +## Properties + +### file\_key + +• **file\_key**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/get-download-url.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md similarity index 54% rename from www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md index b65b9f7fae..53abe7871a 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesCreateReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesCreateReq.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPriceListPricesCreateReq -[internal](../modules/internal-17.md).AdminPriceListPricesCreateReq +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPriceListPricesCreateReq ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/price-list.d.ts:35 +packages/medusa/dist/types/price-list.d.ts:35 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:34 +packages/medusa/dist/types/price-list.d.ts:34 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:38 +packages/medusa/dist/types/price-list.d.ts:38 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:37 +packages/medusa/dist/types/price-list.d.ts:37 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:33 +packages/medusa/dist/types/price-list.d.ts:33 ___ @@ -60,4 +64,4 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:36 +packages/medusa/dist/types/price-list.d.ts:36 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md similarity index 55% rename from www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md index 28cdd4fb40..658b108e3c 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-17.AdminPriceListPricesUpdateReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPriceListPricesUpdateReq.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: AdminPriceListPricesUpdateReq -[internal](../modules/internal-17.md).AdminPriceListPricesUpdateReq +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminPriceListPricesUpdateReq ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/price-list.d.ts:28 +packages/medusa/dist/types/price-list.d.ts:28 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:26 +packages/medusa/dist/types/price-list.d.ts:26 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:24 +packages/medusa/dist/types/price-list.d.ts:24 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:30 +packages/medusa/dist/types/price-list.d.ts:30 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:29 +packages/medusa/dist/types/price-list.d.ts:29 ___ @@ -60,7 +64,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:25 +packages/medusa/dist/types/price-list.d.ts:25 ___ @@ -70,4 +74,4 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:27 +packages/medusa/dist/types/price-list.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md new file mode 100644 index 0000000000..247e69e2da --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminRegionsRes.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminRegionsRes + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminRegionsRes + +**`Schema`** + +AdminRegionsRes +type: object +x-expanded-relations: + field: region + relations: + - countries + - fulfillment_providers + - payment_providers + eager: + - fulfillment_providers + - payment_providers +required: + - region +properties: + region: + description: "Region details." + $ref: "#/components/schemas/Region" + +## Properties + +### region + +• **region**: [`Region`](internal-3.Region.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:29 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md new file mode 100644 index 0000000000..149a9ebefb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordRequest.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminResetPasswordRequest + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminResetPasswordRequest + +**`Schema`** + +AdminResetPasswordRequest +type: object +required: + - token + - password +properties: + email: + description: "The User's email." + type: string + format: email + token: + description: "The password-reset token generated when the password reset was requested." + type: string + password: + description: "The User's new password." + type: string + format: password + +## Properties + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:93 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:95 + +___ + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md new file mode 100644 index 0000000000..af2000334e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminResetPasswordTokenRequest.md @@ -0,0 +1,29 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminResetPasswordTokenRequest + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminResetPasswordTokenRequest + +**`Schema`** + +AdminResetPasswordTokenRequest +type: object +required: + - email +properties: + email: + description: "The User's email." + type: string + format: email + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password-token.d.ts:77 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md new file mode 100644 index 0000000000..5f4410740f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpdatePaymentCollectionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminUpdatePaymentCollectionsReq + +**`Schema`** + +AdminUpdatePaymentCollectionsReq +type: object +properties: + description: + description: A description to create or update the payment collection. + type: string + metadata: + description: A set of key-value pairs to hold additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:81 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/update-payment-collection.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md new file mode 100644 index 0000000000..e4a6b1e4c4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminUpdateUserRequest.md @@ -0,0 +1,82 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AdminUpdateUserRequest + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AdminUpdateUserRequest + +**`Schema`** + +AdminUpdateUserRequest +type: object +properties: + first_name: + description: "The first name of the User." + type: string + last_name: + description: "The last name of the User." + type: string + role: + description: "The role assigned to the user. These roles don't provide any different privileges." + type: string + enum: [admin, member, developer] + api_token: + description: "The API token of the User." + type: string + metadata: + description: An optional set of key-value pairs with additional information. + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### api\_token + +• `Optional` **api\_token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:95 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:92 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:93 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:96 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/update-user.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md new file mode 100644 index 0000000000..e4ade935ec --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfig.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AnalyticsConfig + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AnalyticsConfig + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`AnalyticsConfig`** + +## Properties + +### anonymize + +• **anonymize**: `boolean` + +#### Defined in + +packages/medusa/dist/models/analytics-config.d.ts:5 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/analytics-config.d.ts:6 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### opt\_out + +• **opt\_out**: `boolean` + +#### Defined in + +packages/medusa/dist/models/analytics-config.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### user\_id + +• **user\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/analytics-config.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md new file mode 100644 index 0000000000..86a3ba81bd --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AnalyticsConfigService.md @@ -0,0 +1,296 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AnalyticsConfigService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AnalyticsConfigService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AnalyticsConfigService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### analyticsConfigRepository\_ + +• `Protected` `Readonly` **analyticsConfigRepository\_**: `Repository`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:12 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### userService\_ + +• `Protected` `Readonly` **userService\_**: [`UserService`](internal-8.internal.UserService.md) + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:13 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +Creates an analytics config. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | `string` | +| `data` | [`CreateAnalyticsConfig`](../modules/internal-8.md#createanalyticsconfig) | + +#### Returns + +`Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:19 + +___ + +### delete + +▸ **delete**(`userId`): `Promise`<`void`\> + +Deletes an analytics config. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:27 + +___ + +### retrieve + +▸ **retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | `string` | + +#### Returns + +`Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:15 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +Updates an analytics config. If the config does not exist, it will be created instead. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | `string` | +| `update` | [`UpdateAnalyticsConfig`](../modules/internal-8.md#updateanalyticsconfig) | + +#### Returns + +`Promise`<[`AnalyticsConfig`](internal-8.internal.AnalyticsConfig.md)\> + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:23 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](internal-8.internal.AnalyticsConfigService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AnalyticsConfigService`](internal-8.internal.AnalyticsConfigService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md new file mode 100644 index 0000000000..1da37b53f4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.AuthService.md @@ -0,0 +1,317 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: AuthService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).AuthService + +Can authenticate a user based on email password combination + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`AuthService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:16 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### userService\_ + +• `Protected` `Readonly` **userService\_**: [`UserService`](internal-8.internal.UserService.md) + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:15 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authenticate + +▸ **authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +Authenticates a given user based on an email, password combination. Uses +scrypt to match password with hashed value. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | the email of the user | +| `password` | `string` | the password of the user | + +#### Returns + +`Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +success: whether authentication succeeded + user: the user document if authentication succeeded + error: a string with the error message + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:44 + +___ + +### authenticateAPIToken + +▸ **authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +Authenticates a given user with an API token + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `token` | `string` | the api_token of the user to authenticate | + +#### Returns + +`Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +success: whether authentication succeeded + user: the user document if authentication succeeded + error: a string with the error message + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:33 + +___ + +### authenticateCustomer + +▸ **authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +Authenticates a customer based on an email, password combination. Uses +scrypt to match password with hashed value. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | the email of the user | +| `password` | `string` | the password of the user | + +#### Returns + +`Promise`<[`AuthenticateResult`](../modules/internal-8.md#authenticateresult)\> + +success: whether authentication succeeded + customer: the customer document if authentication succeded + error: a string with the error message + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:55 + +___ + +### comparePassword\_ + +▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\> + +Verifies if a password is valid given the provided password hash + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `password` | `string` | the raw password to check | +| `hash` | `string` | the hash to compare against | + +#### Returns + +`Promise`<`boolean`\> + +the result of the comparison + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:24 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`AuthService`](internal-8.internal.AuthService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`AuthService`](internal-8.internal.AuthService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md new file mode 100644 index 0000000000..def88341dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.BatchJobService.md @@ -0,0 +1,497 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: BatchJobService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).BatchJobService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`BatchJobService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### batchJobRepository\_ + +• `Protected` `Readonly` **batchJobRepository\_**: `Repository`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:27 + +___ + +### batchJobStatusMapToProps + +• `Protected` **batchJobStatusMapToProps**: `Map`<[`BatchJobStatus`](../enums/internal-2.BatchJobStatus.md), { `entityColumnName`: `string` ; `eventType`: `string` }\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:30 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:28 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### strategyResolver\_ + +• `Protected` `Readonly` **strategyResolver\_**: [`StrategyResolverService`](internal-8.internal.StrategyResolverService.md) + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:29 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `COMPLETED` | `string` | +| `CONFIRMED` | `string` | +| `CREATED` | `string` | +| `FAILED` | `string` | +| `PRE_PROCESSED` | `string` | +| `PROCESSING` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:17 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:42 + +___ + +### complete + +▸ **complete**(`batchJobOrId`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:41 + +___ + +### confirm + +▸ **confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:40 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`BatchJobCreateProps`](../modules/internal-8.internal.md#batchjobcreateprops) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:37 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](internal-2.BatchJob.md)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector?` | [`FilterableBatchJobProps`](internal-8.internal.FilterableBatchJobProps.md) | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`BatchJob`](internal-2.BatchJob.md)\> | + +#### Returns + +`Promise`<[[`BatchJob`](internal-2.BatchJob.md)[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:36 + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput) | +| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](../modules/internal.md#record)<`string`, `any`\>\> | + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:46 + +___ + +### retrieve + +▸ **retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`BatchJob`](internal-2.BatchJob.md)\> | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:35 + +___ + +### setFailed + +▸ **setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | +| `error?` | `string` \| [`BatchJobResultError`](../modules/internal-2.md#batchjobresulterror) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:45 + +___ + +### setPreProcessingDone + +▸ **setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:43 + +___ + +### setProcessing + +▸ **setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:44 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | +| `data` | [`Partial`](../modules/internal-8.md#partial)<[`Pick`](../modules/internal-1.md#pick)<[`BatchJob`](internal-2.BatchJob.md), ``"context"`` \| ``"result"``\>\> | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:38 + +___ + +### updateStatus + +▸ `Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobOrId` | `string` \| [`BatchJob`](internal-2.BatchJob.md) | +| `status` | [`BatchJobStatus`](../enums/internal-2.BatchJobStatus.md) | + +#### Returns + +`Promise`<[`BatchJob`](internal-2.BatchJob.md)\> + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:39 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`BatchJobService`](internal-8.internal.BatchJobService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`BatchJobService`](internal-8.internal.BatchJobService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md new file mode 100644 index 0000000000..2a4dba965c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CartService.md @@ -0,0 +1,1499 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CartService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CartService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`CartService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### addressRepository\_ + +• `Protected` `Readonly` **addressRepository\_**: `Repository`<[`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:54 + +___ + +### cartRepository\_ + +• `Protected` `Readonly` **cartRepository\_**: `Repository`<[`Cart`](internal-3.Cart.md)\> & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:53 + +___ + +### customShippingOptionService\_ + +• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:73 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:65 + +___ + +### discountService\_ + +• `Protected` `Readonly` **discountService\_**: [`DiscountService`](internal-8.internal.DiscountService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:68 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:57 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:76 + +___ + +### getTotalsRelations + +• `Private` **getTotalsRelations**: `any` + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:359 + +___ + +### giftCardService\_ + +• `Protected` `Readonly` **giftCardService\_**: [`GiftCardService`](internal-8.internal.GiftCardService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:69 + +___ + +### lineItemAdjustmentService\_ + +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:75 + +___ + +### lineItemRepository\_ + +• `Protected` `Readonly` **lineItemRepository\_**: `Repository`<[`LineItem`](internal-3.LineItem.md)\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](internal-3.ReturnItem.md) }[]\> } + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:56 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:63 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### newTotalsService\_ + +• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:72 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:64 + +___ + +### paymentSessionRepository\_ + +• `Protected` `Readonly` **paymentSessionRepository\_**: `Repository`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:55 + +___ + +### priceSelectionStrategy\_ + +• `Protected` `Readonly` **priceSelectionStrategy\_**: [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:74 + +___ + +### pricingService\_ + +• `Protected` `Readonly` **pricingService\_**: [`PricingService`](internal-8.internal.PricingService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:78 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:59 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:77 + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:58 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:62 + +___ + +### salesChannelService\_ + +• `Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](internal-8.internal.SalesChannelService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:61 + +___ + +### shippingMethodRepository\_ + +• `Protected` `Readonly` **shippingMethodRepository\_**: `Repository`<[`ShippingMethod`](internal-3.ShippingMethod.md)\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:52 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:66 + +___ + +### shippingProfileService\_ + +• `Protected` `Readonly` **shippingProfileService\_**: [`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:67 + +___ + +### storeService\_ + +• `Protected` `Readonly` **storeService\_**: [`StoreService`](internal-8.internal.StoreService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:60 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:70 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:71 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `CUSTOMER_UPDATED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:47 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addLineItem + +▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\> + +Adds a line item to the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart that we will add to | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | the line item to add. | +| `config?` | `Object` | validateSalesChannels - should check if product belongs to the same sales channel as cart (if cart has associated sales channel) | +| `config.validateSalesChannels` | `boolean` | - | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +**`Deprecated`** + +Use [addOrUpdateLineItems](internal-8.internal.CartService.md#addorupdatelineitems) instead. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:146 + +___ + +### addOrUpdateLineItems + +▸ **addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\> + +Adds or update one or multiple line items to the cart. It also update all existing items in the cart +to have has_shipping to false. Finally, the adjustments will be updated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart that we will add to | +| `lineItems` | [`LineItem`](internal-3.LineItem.md) \| [`LineItem`](internal-3.LineItem.md)[] | the line items to add. | +| `config?` | `Object` | validateSalesChannels - should check if product belongs to the same sales channel as cart (if cart has associated sales channel) | +| `config.validateSalesChannels` | `boolean` | - | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:159 + +___ + +### addShippingMethod + +▸ **addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Adds the shipping method to the list of shipping methods associated with +the cart. Shipping Methods are the ways that an order is shipped, whereas a +Shipping Option is a possible way to ship an order. Shipping Methods may +also have additional details in the data field such as an id for a package +shop. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrId` | `string` \| [`Cart`](internal-3.Cart.md) | the id of the cart to add shipping method to | +| `optionId` | `string` | id of shipping option to add as valid method | +| `data?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the fulmillment data for the method | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:310 + +___ + +### adjustFreeShipping\_ + +▸ `Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\> + +Ensures shipping total on cart is correct in regards to a potential free +shipping discount +If a free shipping is present, we set shipping methods price to 0 +if a free shipping was present, we set shipping methods to original amount + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to adjust free shipping for | +| `shouldAdd` | `boolean` | flag to indicate, if we should add or remove | + +#### Returns + +`Promise`<`void`\> + +void + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:179 + +___ + +### applyDiscount + +▸ **applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\> + +Updates the cart's discounts. +If discount besides free shipping is already applied, this +will be overwritten +Throws if discount regions does not include the cart region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to update | +| `discountCode` | `string` | the discount code | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:228 + +___ + +### applyDiscounts + +▸ **applyDiscounts**(`cart`, `discountCodes`): `Promise`<`void`\> + +Updates the cart's discounts. +If discount besides free shipping is already applied, this +will be overwritten +Throws if discount regions does not include the cart region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to update | +| `discountCodes` | `string`[] | the discount code(s) to apply | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:237 + +___ + +### applyGiftCard\_ + +▸ `Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | +| `code` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:219 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePayment + +▸ **authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Authorizes a payment for a cart. +Will authorize with chosen payment provider. This will return +a payment object, that we will use to update our cart payment with. +Additionally, if the payment does not require more or fails, we will +set the payment on the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to authorize payment for | +| `context?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> & { `cart_id`: `string` } | object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling. | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the resulting cart + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:264 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Creates a cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CartCreateProps`](../modules/internal-8.md#cartcreateprops) | the data to create the cart with | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:108 + +___ + +### createOrFetchGuestCustomerFromEmail\_ + +▸ `Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Creates or fetches a user based on an email. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | the email to use | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +the resultign customer object + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:202 + +___ + +### createTaxLines + +▸ **createTaxLines**(`cartOrId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartOrId` | `string` \| [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:344 + +___ + +### decorateTotals + +▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Cart`](internal-3.Cart.md), ``"total"``\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | +| `totalsConfig?` | [`TotalsConfig`](../modules/internal-8.md#totalsconfig) | + +#### Returns + +`Promise`<[`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Cart`](internal-3.Cart.md), ``"total"``\>\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:346 + +___ + +### decorateTotals\_ + +▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | +| `totalsToSelect` | [`TotalField`](../modules/internal-8.internal.md#totalfield)[] | +| `options?` | [`TotalsConfig`](../modules/internal-8.md#totalsconfig) | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +**`Deprecated`** + +Use decorateTotals instead + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:358 + +___ + +### delete + +▸ **delete**(`cartId`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Deletes a cart from the database. Completed carts cannot be deleted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to delete | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the deleted cart or undefined if the cart was not found. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:333 + +___ + +### deletePaymentSession + +▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Removes a payment session from the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to remove from | +| `providerId` | `string` | the id of the provider whose payment session should be removed. | + +#### Returns + +`Promise`<`void`\> + +the resulting cart. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:290 + +___ + +### deleteTaxLines + +▸ **deleteTaxLines**(`id`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:345 + +___ + +### findCustomShippingOption + +▸ **findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md) + +Finds the cart's custom shipping options based on the passed option id. +throws if custom options is not empty and no shipping option corresponds to optionId + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartCustomShippingOptions` | [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)[] | the cart's custom shipping options | +| `optionId` | `string` | id of the normal or custom shipping option to find in the cartCustomShippingOptions | + +#### Returns + +`undefined` \| [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md) + +custom shipping option + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:318 + +___ + +### getValidatedSalesChannel + +▸ `Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `salesChannelId?` | `string` | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:109 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Cart`](internal-3.Cart.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`FilterableCartProps`](internal-8.FilterableCartProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> | config object | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:85 + +___ + +### onSalesChannelChange + +▸ `Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\> + +Remove the cart line item that does not belongs to the newly assigned sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | The cart being updated | +| `newSalesChannelId` | `string` | The new sales channel being assigned to the cart | + +#### Returns + +`Promise`<`void`\> + +void + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:189 + +___ + +### refreshAdjustments\_ + +▸ `Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:347 + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Refreshes a payment session on a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to remove from | +| `providerId` | `string` | the id of the provider whose payment session should be removed. | + +#### Returns + +`Promise`<`void`\> + +the resulting cart. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:298 + +___ + +### removeDiscount + +▸ **removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Removes a discount based on a discount code. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to remove from | +| `discountCode` | `string` | the discount code to remove | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the resulting cart + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:244 + +___ + +### removeLineItem + +▸ **removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Removes a line item from the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart that we will remove from | +| `lineItemId` | `string` | the line item to remove. | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:116 + +___ + +### retrieve + +▸ **retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Gets a cart by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to get. | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> | the options to get a cart | +| `totalsConfig?` | [`TotalsConfig`](../modules/internal-8.md#totalsconfig) | | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the cart document. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:93 + +___ + +### retrieveLegacy + +▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> | +| `totalsConfig?` | [`TotalsConfig`](../modules/internal-8.md#totalsconfig) | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +**`Deprecated`** + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:101 + +___ + +### retrieveWithTotals + +▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Cart`](internal-3.Cart.md), ``"total"``\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> | +| `totalsConfig?` | [`TotalsConfig`](../modules/internal-8.md#totalsconfig) | + +#### Returns + +`Promise`<[`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Cart`](internal-3.Cart.md), ``"total"``\>\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:102 + +___ + +### setMetadata + +▸ **setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Dedicated method to set metadata for a cart. +To ensure that plugins does not overwrite each +others metadata fields, setMetadata is provided. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the cart to apply metadata to. | +| `key` | `string` | key for metadata field | +| `value` | `string` \| `number` | value for metadata field. | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +resolves to the updated result. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:343 + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> + +Selects a payment session for a cart and creates a payment object in the external provider system + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to add payment method to | +| `providerId` | `string` | the id of the provider to be set to the cart | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:272 + +___ + +### setPaymentSessions + +▸ **setPaymentSessions**(`cartOrCartId`): `Promise`<`void`\> + +Creates, updates and sets payment sessions associated with the cart. The +first time the method is called payment sessions will be created for each +provider. Additional calls will ensure that payment sessions have correct +amounts, currencies, etc. as well as make sure to filter payment sessions +that are not available for the cart's region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrCartId` | `string` \| [`Cart`](internal-3.Cart.md) | the id of the cart to set payment session for | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation. + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:282 + +___ + +### setRegion\_ + +▸ `Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\> + +Set's the region of a cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to set region on | +| `regionId` | `string` | the id of the region to set the region to | +| `countryCode` | ``null`` \| `string` | the country code to set the country to | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:327 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### transformQueryForTotals\_ + +▸ `Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> & { `totalsToSelect`: [`TotalField`](../modules/internal-8.internal.md#totalfield)[] } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> | + +#### Returns + +[`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Cart`](internal-3.Cart.md)\> & { `totalsToSelect`: [`TotalField`](../modules/internal-8.internal.md#totalfield)[] } + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:348 + +___ + +### update + +▸ **update**(`cartOrId`, `data`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartOrId` | `string` \| [`Cart`](internal-3.Cart.md) | +| `data` | [`CartUpdateProps`](../modules/internal-8.md#cartupdateprops) | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:180 + +___ + +### updateBillingAddress\_ + +▸ `Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> + +Updates the cart's billing address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to update | +| `addressOrId` | `string` \| [`AddressPayload`](internal.AddressPayload.md) \| [`Partial`](../modules/internal-8.md#partial)<[`Address`](internal-3.Address.md)\> | the value to set the billing address to | +| `addrRepo` | `Repository`<[`Address`](internal-3.Address.md)\> | the repository to use for address updates | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:210 + +___ + +### updateCustomerId\_ + +▸ `Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\> + +Sets the customer id of a cart + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to add email to | +| `customerId` | `string` | the customer to add to cart | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:196 + +___ + +### updateLineItem + +▸ **updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Updates a cart's existing line item. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to update | +| `lineItemId` | `string` | the id of the line item to update. | +| `update` | [`LineItemUpdate`](../modules/internal-8.md#lineitemupdate) | - | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:169 + +___ + +### updatePaymentSession + +▸ **updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](internal-3.Cart.md)\> + +Updates the currently selected payment session. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the cart to update the payment session for | +| `update` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the data to update the payment session with | + +#### Returns + +`Promise`<[`Cart`](internal-3.Cart.md)\> + +the resulting cart + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:251 + +___ + +### updateShippingAddress\_ + +▸ `Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> + +Updates the cart's shipping address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to update | +| `addressOrId` | `string` \| [`AddressPayload`](internal.AddressPayload.md) \| [`Partial`](../modules/internal-8.md#partial)<[`Address`](internal-3.Address.md)\> | the value to set the shipping address to | +| `addrRepo` | `Repository`<[`Address`](internal-3.Address.md)\> | the repository to use for address updates | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:218 + +___ + +### updateUnitPrices\_ + +▸ `Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | +| `regionId?` | `string` | +| `customer_id?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:319 + +___ + +### validateLineItem + +▸ `Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\> + +Check if line item's variant belongs to the cart's sales channel. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `sales_channel_id` | `Object` | the cart for the line item | +| `sales_channel_id.sales_channel_id` | ``null`` \| `string` | - | +| `lineItem` | [`LineItemValidateData`](../modules/internal-8.md#lineitemvalidatedata) | the line item being added | + +#### Returns + +`Promise`<`boolean`\> + +a boolean indicating validation result + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:133 + +___ + +### validateLineItemShipping\_ + +▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `boolean` + +Checks if a given line item has a shipping method that can fulfill it. +Returns true if all products in the cart can be fulfilled with the current +shipping methods. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingMethods` | [`ShippingMethod`](internal-3.ShippingMethod.md)[] | the set of shipping methods to check from | +| `lineItemShippingProfiledId` | `string` | - | + +#### Returns + +`boolean` + +boolean representing whether shipping method is validated + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:125 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CartService`](internal-8.internal.CartService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`CartService`](internal-8.internal.CartService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md new file mode 100644 index 0000000000..0766653c44 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimItemService.md @@ -0,0 +1,345 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimItemService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ClaimItemService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ClaimItemService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### claimImageRepository\_ + +• `Protected` `Readonly` **claimImageRepository\_**: `Repository`<[`ClaimImage`](internal-3.ClaimImage.md)\> + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:20 + +___ + +### claimItemRepository\_ + +• `Protected` `Readonly` **claimItemRepository\_**: `Repository`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:18 + +___ + +### claimTagRepository\_ + +• `Protected` `Readonly` **claimTagRepository\_**: `Repository`<[`ClaimTag`](internal-3.ClaimTag.md)\> + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:19 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:17 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:16 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `CREATED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:11 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateClaimItemInput`](../modules/internal-8.md#createclaimiteminput) | + +#### Returns + +`Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:28 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ClaimItem`](internal-3.ClaimItem.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ClaimItem`](internal-3.ClaimItem.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ClaimItem`](internal-3.ClaimItem.md)\> | the config object for find | + +#### Returns + +`Promise`<[`ClaimItem`](internal-3.ClaimItem.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:35 + +___ + +### retrieve + +▸ **retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +Gets a claim item by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `claimItemId` | `string` | id of ClaimItem to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ClaimItem`](internal-3.ClaimItem.md)\> | configuration for the find operation | + +#### Returns + +`Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +the ClaimItem + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:42 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `any` | +| `data` | `any` | + +#### Returns + +`Promise`<[`ClaimItem`](internal-3.ClaimItem.md)\> + +#### Defined in + +packages/medusa/dist/services/claim-item.d.ts:29 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ClaimItemService`](internal-8.internal.ClaimItemService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ClaimItemService`](internal-8.internal.ClaimItemService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md new file mode 100644 index 0000000000..14f9a29523 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ClaimService.md @@ -0,0 +1,625 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ClaimService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ClaimService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ClaimService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### addressRepository\_ + +• `Protected` `Readonly` **addressRepository\_**: `Repository`<[`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:50 + +___ + +### claimItemService\_ + +• `Protected` `Readonly` **claimItemService\_**: [`ClaimItemService`](internal-8.internal.ClaimItemService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:54 + +___ + +### claimRepository\_ + +• `Protected` `Readonly` **claimRepository\_**: `Repository`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:51 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:55 + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:56 + +___ + +### fulfillmentService\_ + +• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](internal-8.FulfillmentService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:57 + +___ + +### lineItemRepository\_ + +• `Protected` `Readonly` **lineItemRepository\_**: `Repository`<[`LineItem`](internal-3.LineItem.md)\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](internal-3.ReturnItem.md) }[]\> } + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:53 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:58 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:59 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:65 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:60 + +___ + +### returnService\_ + +• `Protected` `Readonly` **returnService\_**: [`ReturnService`](internal-8.internal.ReturnService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:61 + +___ + +### shippingMethodRepository\_ + +• `Protected` `Readonly` **shippingMethodRepository\_**: `Repository`<[`ShippingMethod`](internal-3.ShippingMethod.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:52 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:62 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:63 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:64 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `CREATED` | `string` | +| `FULFILLMENT_CREATED` | `string` | +| `REFUND_PROCESSED` | `string` | +| `SHIPMENT_CREATED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:42 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`id`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:109 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillmentId` | `string` | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:101 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +Creates a Claim on an Order. Claims consists of items that are claimed and +optionally items to be sent as replacement for the claimed items. The +shipping address that the new items will be shipped to + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreateClaimInput`](../modules/internal-8.md#createclaiminput) | the object containing all data required to create a claim | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +created claim + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:88 + +___ + +### createFulfillment + +▸ **createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the object containing all data required to create a claim | +| `config?` | `Object` | config object | +| `config.location_id?` | `string` | - | +| `config.metadata?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | config metadata | +| `config.no_notification?` | `boolean` | config no notification | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +created claim + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:96 + +___ + +### createShipment + +▸ **createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `fulfillmentId` | `string` | +| `trackingLinks?` | { `tracking_number`: `string` }[] | +| `config?` | `Object` | +| `config.metadata` | `Object` | +| `config.no_notification` | `undefined` | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:103 + +___ + +### getRefundTotalForClaimLinesOnOrder + +▸ `Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\> + +Finds claim line items on an order and calculates the refund amount. +There are three places too look: +- Order items +- Swap items +- Claim items (from previous claims) +Note, it will attempt to return early from each of these places to avoid having to iterate over all items every time. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to find claim lines on | +| `claimItems` | [`CreateClaimItemInput`](../modules/internal-8.md#createclaimiteminput)[] | the claim items to match against | + +#### Returns + +`Promise`<`number`\> + +the refund amount + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:80 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `any` | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ClaimOrder`](internal-3.ClaimOrder.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:115 + +___ + +### processRefund + +▸ **processRefund**(`id`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:102 + +___ + +### retrieve + +▸ **retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +Gets an order by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `claimId` | `string` | id of the claim order to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ClaimOrder`](internal-3.ClaimOrder.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +the order document + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:122 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `data` | [`UpdateClaimInput`](../modules/internal-8.md#updateclaiminput) | + +#### Returns + +`Promise`<[`ClaimOrder`](internal-3.ClaimOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:67 + +___ + +### validateCreateClaimInput + +▸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateClaimInput`](../modules/internal-8.md#createclaiminput) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:68 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ClaimService`](internal-8.internal.ClaimService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ClaimService`](internal-8.internal.ClaimService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md new file mode 100644 index 0000000000..3817af510b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md @@ -0,0 +1,311 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CurrencyService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CurrencyService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`CurrencyService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### currencyRepository\_ + +• `Protected` `Readonly` **currencyRepository\_**: `Repository`<[`Currency`](internal-3.Currency.md)\> + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:19 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:20 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:16 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](internal-3.Currency.md)[], `number`]\> + +Lists currencies based on the provided parameters and includes the count of +currencies that match the query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Currency`](internal-3.Currency.md)\> | an object that defines rules to filter currencies by | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Currency`](internal-3.Currency.md)\> | object that defines the scope for what should be returned | + +#### Returns + +`Promise`<[[`Currency`](internal-3.Currency.md)[], `number`]\> + +an array containing the currencies as + the first element and the total count of products that matches the query + as the second element. + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:40 + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`): `Promise`<[`Currency`](internal-3.Currency.md)\> + +Return the currency + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | The code of the currency that must be retrieve | + +#### Returns + +`Promise`<[`Currency`](internal-3.Currency.md)\> + +The currency + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:28 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](internal-3.Currency.md)\> + +Update a currency + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | The code of the currency to update | +| `data` | [`UpdateCurrencyInput`](../modules/internal-8.md#updatecurrencyinput) | The data that must be updated on the currency | + +#### Returns + +`Promise`<`undefined` \| [`Currency`](internal-3.Currency.md)\> + +The updated currency + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:47 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CurrencyService`](internal-8.internal.CurrencyService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`CurrencyService`](internal-8.internal.CurrencyService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md new file mode 100644 index 0000000000..d5d6f2f81e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOption.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomShippingOption + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CustomShippingOption + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`CustomShippingOption`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:11 + +___ + +### cart + +• **cart**: [`Cart`](internal-3.Cart.md) + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:9 + +___ + +### cart\_id + +• **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:8 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:10 + +___ + +### price + +• **price**: `number` + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:5 + +___ + +### shipping\_option + +• **shipping\_option**: [`ShippingOption`](internal-3.ShippingOption.md) + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:7 + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/custom-shipping-option.d.ts:6 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md new file mode 100644 index 0000000000..36e91d6bcb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomShippingOptionService.md @@ -0,0 +1,279 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomShippingOptionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CustomShippingOptionService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`CustomShippingOptionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customShippingOptionRepository\_ + +• `Protected` **customShippingOptionRepository\_**: `Repository`<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> + +#### Defined in + +packages/medusa/dist/services/custom-shipping-option.d.ts:12 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> + +Creates a custom shipping option + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | [`CreateCustomShippingOptionInput`](../modules/internal-8.md#createcustomshippingoptioninput) \| [`CreateCustomShippingOptionInput`](../modules/internal-8.md#createcustomshippingoptioninput)[] | +| `TResult` | `T` extends [`CreateCustomShippingOptionInput`](../modules/internal-8.md#createcustomshippingoptioninput)[] ? [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)[] : [`CustomShippingOption`](internal-8.internal.CustomShippingOption.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `T` | the custom shipping option to create | + +#### Returns + +`Promise`<`TResult`\> + +resolves to the creation result + +#### Defined in + +packages/medusa/dist/services/custom-shipping-option.d.ts:32 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)[]\> + +Fetches all custom shipping options based on the given selector + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)[]\> + +custom shipping options matching the query + +#### Defined in + +packages/medusa/dist/services/custom-shipping-option.d.ts:26 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> + +Retrieves a specific shipping option. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the custom shipping option to retrieve. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> | any options needed to query for the result. | + +#### Returns + +`Promise`<[`CustomShippingOption`](internal-8.internal.CustomShippingOption.md)\> + +the requested custom shipping option. + +#### Defined in + +packages/medusa/dist/services/custom-shipping-option.d.ts:20 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md new file mode 100644 index 0000000000..e073245b4e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerGroupService.md @@ -0,0 +1,412 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerGroupService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CustomerGroupService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`CustomerGroupService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customerGroupRepository\_ + +• `Protected` `Readonly` **customerGroupRepository\_**: `Repository`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> & { `addCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> ; `findWithRelationsAndCount`: (`relations?`: `FindOptionsRelations`<[`CustomerGroup`](internal-3.CustomerGroup.md)\>, `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions)) => `Promise`<[[`CustomerGroup`](internal-3.CustomerGroup.md)[], `number`]\> ; `removeCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:14 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:15 + +___ + +### handleCreationFail + +• `Private` **handleCreationFail**: `any` + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:76 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addCustomers + +▸ **addCustomers**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +Add a batch of customers to a customer group at once + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the customer group to add customers to | +| `customerIds` | `string` \| `string`[] | customer id's to add to the group | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +the customer group after insertion + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:30 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`group`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +Creates a customer group with the provided data. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `group` | `DeepPartial`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> | the customer group to create | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:23 + +___ + +### delete + +▸ **delete**(`groupId`): `Promise`<`void`\> + +Remove customer group + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `groupId` | `string` | id of the customer group to delete | + +#### Returns + +`Promise`<`void`\> + +a promise + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:45 + +___ + +### list + +▸ **list**(`selector`, `config`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)[]\> + +List customer groups. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `undefined` \| [`Selector`](../modules/internal-8.internal.md#selector)<[`CustomerGroup`](internal-3.CustomerGroup.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | +| `config` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`CustomerGroup`](internal-3.CustomerGroup.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:53 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config`): `Promise`<[[`CustomerGroup`](internal-3.CustomerGroup.md)[], `number`]\> + +Retrieve a list of customer groups and total count of records that match the query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `undefined` \| [`Selector`](../modules/internal-8.internal.md#selector)<[`CustomerGroup`](internal-3.CustomerGroup.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | +| `config` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`CustomerGroup`](internal-3.CustomerGroup.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[[`CustomerGroup`](internal-3.CustomerGroup.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:64 + +___ + +### removeCustomer + +▸ **removeCustomer**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +Remove list of customers from a customergroup + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the customer group from which the customers are removed | +| `customerIds` | `string` \| `string`[] | id's of the customer to remove from group | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +the customergroup with the provided id + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:75 + +___ + +### retrieve + +▸ **retrieve**(`customerGroupId`, `config?`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customerGroupId` | `string` | +| `config?` | `Object` | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:17 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`customerGroupId`, `update`): `Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +Update a customer group. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customerGroupId` | `string` | id of the customer group | +| `update` | [`CustomerGroupUpdate`](internal-8.CustomerGroupUpdate.md) | customer group partial data | + +#### Returns + +`Promise`<[`CustomerGroup`](internal-3.CustomerGroup.md)\> + +resulting customer group + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:38 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomerGroupService`](internal-8.internal.CustomerGroupService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`CustomerGroupService`](internal-8.internal.CustomerGroupService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md new file mode 100644 index 0000000000..7852e43a8c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.CustomerService.md @@ -0,0 +1,669 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: CustomerService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CustomerService + +Provides layer to manipulate customers. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`CustomerService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### addressRepository\_ + +• `Protected` `Readonly` **addressRepository\_**: `Repository`<[`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:21 + +___ + +### customerRepository\_ + +• `Protected` `Readonly` **customerRepository\_**: `Repository`<[`Customer`](internal-3.Customer.md)\> & { `listAndCount`: (`query`: `Object`, `q?`: `string`) => `Promise`<[[`Customer`](internal-3.Customer.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:20 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:22 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### retrieve\_ + +• `Private` **retrieve\_**: `any` + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:62 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `PASSWORD_RESET` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:23 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addAddress + +▸ **addAddress**(`customerId`, `address`): `Promise`<[`Customer`](internal-3.Customer.md) \| [`Address`](internal-3.Address.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customerId` | `string` | +| `address` | [`AddressCreatePayload`](internal.AddressCreatePayload.md) | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md) \| [`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:121 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### count + +▸ **count**(): `Promise`<`number`\> + +Return the total number of documents in database + +#### Returns + +`Promise`<`number`\> + +the result of the count operation + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:61 + +___ + +### create + +▸ **create**(`customer`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Creates a customer from an email - customers can have accounts associated, +e.g. to login and view order history, etc. If a password is provided the +customer will automatically get an account, otherwise the customer is just +used to hold details of customers. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customer` | [`CreateCustomerInput`](../modules/internal-8.md#createcustomerinput) | the customer to create | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +the result of create + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:102 + +___ + +### delete + +▸ **delete**(`customerId`): `Promise`<`void` \| [`Customer`](internal-3.Customer.md)\> + +Deletes a customer from a given customer id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customerId` | `string` | the id of the customer to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void` \| [`Customer`](internal-3.Customer.md)\> + +the result of the delete operation. + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:128 + +___ + +### generateResetPasswordToken + +▸ **generateResetPasswordToken**(`customerId`): `Promise`<`string`\> + +Generate a JSON Web token, that will be sent to a customer, that wishes to +reset password. +The token will be signed with the customer's current password hash as a +secret a long side a payload with userId and the expiry time for the token, +which is always 15 minutes. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customerId` | `string` | the customer to reset the password for | + +#### Returns + +`Promise`<`string`\> + +the generated JSON web token + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:38 + +___ + +### hashPassword\_ + +▸ **hashPassword_**(`password`): `Promise`<`string`\> + +Hashes a password + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `password` | `string` | the value to hash | + +#### Returns + +`Promise`<`string`\> + +hashed password + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:93 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Customer`](internal-3.Customer.md)\> & { `groups?`: `string`[] ; `q?`: `string` } | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:44 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Customer`](internal-3.Customer.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Customer`](internal-3.Customer.md)\> & { `groups?`: `string`[] ; `q?`: `string` } | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[[`Customer`](internal-3.Customer.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:53 + +___ + +### listByEmail + +▸ **listByEmail**(`email`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)[]\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:73 + +___ + +### removeAddress + +▸ **removeAddress**(`customerId`, `addressId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customerId` | `string` | +| `addressId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:120 + +___ + +### retrieve + +▸ **retrieve**(`customerId`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Gets a customer by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customerId` | `string` | the id of the customer to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +the customer document. + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:87 + +___ + +### retrieveByEmail + +▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Gets a registered customer by email. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | the email of the customer to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +the customer document. + +**`Deprecated`** + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:70 + +___ + +### retrieveByPhone + +▸ **retrieveByPhone**(`phone`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Gets a customer by phone. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `phone` | `string` | the phone of the customer to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +the customer document. + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:80 + +___ + +### retrieveRegisteredByEmail + +▸ **retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:72 + +___ + +### retrieveUnregisteredByEmail + +▸ **retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Customer`](internal-3.Customer.md)\> | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:71 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`customerId`, `update`): `Promise`<[`Customer`](internal-3.Customer.md)\> + +Updates a customer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customerId` | `string` | the id of the variant. Must be a string that can be casted to an ObjectId | +| `update` | [`UpdateCustomerInput`](../modules/internal-8.md#updatecustomerinput) | an object with the update values. | + +#### Returns + +`Promise`<[`Customer`](internal-3.Customer.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:110 + +___ + +### updateAddress + +▸ **updateAddress**(`customerId`, `addressId`, `address`): `Promise`<[`Address`](internal-3.Address.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customerId` | `string` | +| `addressId` | `string` | +| `address` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | + +#### Returns + +`Promise`<[`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:119 + +___ + +### updateBillingAddress\_ + +▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\> + +Updates the customers' billing address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `customer` | [`Customer`](internal-3.Customer.md) | the Customer to update | +| `addressOrId` | `undefined` \| `string` \| `DeepPartial`<[`Address`](internal-3.Address.md)\> | the value to set the billing address to | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:118 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`CustomerService`](internal-8.internal.CustomerService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md new file mode 100644 index 0000000000..501437022f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionCustomerGroup.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionCustomerGroup + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionCustomerGroup + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:8 + +___ + +### customer\_group + +• `Optional` **customer\_group**: [`CustomerGroup`](internal-3.CustomerGroup.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:6 + +___ + +### customer\_group\_id + +• **customer\_group\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:4 + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](internal-3.DiscountCondition.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:7 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:10 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-customer-group.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md new file mode 100644 index 0000000000..2d130ba929 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProduct.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionProduct + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionProduct + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:8 + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](internal-3.DiscountCondition.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:7 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:10 + +___ + +### product + +• `Optional` **product**: [`Product`](internal-3.Product.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:6 + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md new file mode 100644 index 0000000000..e356981c67 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductCollection.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionProductCollection + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionProductCollection + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:8 + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](internal-3.DiscountCondition.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:7 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:10 + +___ + +### product\_collection + +• `Optional` **product\_collection**: [`ProductCollection`](internal-3.ProductCollection.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:6 + +___ + +### product\_collection\_id + +• **product\_collection\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-collection.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md new file mode 100644 index 0000000000..d804e616dc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductTag.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionProductTag + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionProductTag + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:8 + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](internal-3.DiscountCondition.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:7 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:10 + +___ + +### product\_tag + +• `Optional` **product\_tag**: [`ProductTag`](internal-3.ProductTag.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:6 + +___ + +### product\_tag\_id + +• **product\_tag\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-tag.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md new file mode 100644 index 0000000000..9f717d65d8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionProductType.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionProductType + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionProductType + +## Properties + +### condition\_id + +• **condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:8 + +___ + +### discount\_condition + +• `Optional` **discount\_condition**: [`DiscountCondition`](internal-3.DiscountCondition.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:7 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:10 + +___ + +### product\_type + +• `Optional` **product\_type**: [`ProductType`](internal-3.ProductType.md) + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:6 + +___ + +### product\_type\_id + +• **product\_type\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:4 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/discount-condition-product-type.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md new file mode 100644 index 0000000000..8b0f8b5192 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountConditionService.md @@ -0,0 +1,314 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountConditionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountConditionService + +Provides layer to manipulate discount conditions. + +**`Implements`** + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`DiscountConditionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### discountConditionRepository\_ + +• `Protected` `Readonly` **discountConditionRepository\_**: `Repository`<[`DiscountCondition`](internal-3.DiscountCondition.md)\> & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `overrideExisting?`: `boolean`) => `Promise`<([`DiscountConditionCustomerGroup`](internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](internal-8.internal.DiscountConditionProductType.md))[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| [`DiscountCondition`](internal-3.DiscountCondition.md) & { `discount`: [`Discount`](internal-3.Discount.md) }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: [`DiscountConditionResourceType`](../modules/internal-8.md#discountconditionresourcetype) ; `joinTable`: `string` ; `joinTableForeignKey`: [`DiscountConditionJoinTableForeignKey`](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) ; `joinTableKey`: `string` ; `relatedTable`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: { `conditionId`: `any` ; `resourceId`: `any` ; `type`: `any` }) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:18 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:19 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### delete + +▸ **delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](internal-3.DiscountCondition.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountConditionId` | `string` | + +#### Returns + +`Promise`<`void` \| [`DiscountCondition`](internal-3.DiscountCondition.md)\> + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:32 + +___ + +### removeResources + +▸ **removeResources**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Omit`](../modules/internal-1.md#omit)<[`DiscountConditionInput`](../modules/internal-8.md#discountconditioninput), ``"id"``\> & { `id`: `string` } | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:29 + +___ + +### retrieve + +▸ **retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](internal-3.DiscountCondition.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `conditionId` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`DiscountCondition`](internal-3.DiscountCondition.md)\> | + +#### Returns + +`Promise`<[`DiscountCondition`](internal-3.DiscountCondition.md)\> + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:21 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### upsertCondition + +▸ **upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionCustomerGroup`](internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](internal-8.internal.DiscountConditionProductType.md))[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`DiscountConditionInput`](../modules/internal-8.md#discountconditioninput) | +| `overrideExisting?` | `boolean` | + +#### Returns + +`Promise`<([`DiscountConditionCustomerGroup`](internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](internal-8.internal.DiscountConditionProductType.md))[]\> + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:28 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DiscountConditionService`](internal-8.internal.DiscountConditionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`DiscountConditionService`](internal-8.internal.DiscountConditionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 + +___ + +### resolveConditionType\_ + +▸ `Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md) } + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`DiscountConditionInput`](../modules/internal-8.md#discountconditioninput) | + +#### Returns + +`undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md) } + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md new file mode 100644 index 0000000000..46aabbd8db --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DiscountService.md @@ -0,0 +1,843 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DiscountService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DiscountService + +Provides layer to manipulate discounts. + +**`Implements`** + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`DiscountService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:22 + +___ + +### discountConditionRepository\_ + +• `Protected` `Readonly` **discountConditionRepository\_**: `Repository`<[`DiscountCondition`](internal-3.DiscountCondition.md)\> & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `overrideExisting?`: `boolean`) => `Promise`<([`DiscountConditionCustomerGroup`](internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](internal-8.internal.DiscountConditionProductType.md))[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| [`DiscountCondition`](internal-3.DiscountCondition.md) & { `discount`: [`Discount`](internal-3.Discount.md) }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: [`DiscountConditionResourceType`](../modules/internal-8.md#discountconditionresourcetype) ; `joinTable`: `string` ; `joinTableForeignKey`: [`DiscountConditionJoinTableForeignKey`](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) ; `joinTableKey`: `string` ; `relatedTable`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: { `conditionId`: `any` ; `resourceId`: `any` ; `type`: `any` }) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:25 + +___ + +### discountConditionService\_ + +• `Protected` `Readonly` **discountConditionService\_**: [`DiscountConditionService`](internal-8.internal.DiscountConditionService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:26 + +___ + +### discountRepository\_ + +• `Protected` `Readonly` **discountRepository\_**: `Repository`<[`Discount`](internal-3.Discount.md)\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:21 + +___ + +### discountRuleRepository\_ + +• `Protected` `Readonly` **discountRuleRepository\_**: `Repository`<[`DiscountRule`](internal-3.DiscountRule.md)\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:23 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:31 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:32 + +___ + +### giftCardRepository\_ + +• `Protected` `Readonly` **giftCardRepository\_**: `Repository`<[`GiftCard`](internal-3.GiftCard.md)\> & { `listGiftCardsAndCount`: (`query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`GiftCard`](internal-3.GiftCard.md)\>, `q?`: `string`) => `Promise`<[[`GiftCard`](internal-3.GiftCard.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:24 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### newTotalsService\_ + +• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:28 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:29 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:30 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:27 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addRegion + +▸ **addRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Adds a region to the discount regions array. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | id of discount | +| `regionId` | `string` | id of region to add | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:123 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### calculateDiscountForLineItem + +▸ **calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountId` | `string` | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | +| `calculationContextData` | [`CalculationContextData`](../modules/internal-8.md#calculationcontextdata) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:138 + +___ + +### canApplyForCustomer + +▸ **canApplyForCustomer**(`discountRuleId`, `customerId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountRuleId` | `string` | +| `customerId` | `undefined` \| `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:146 + +___ + +### create + +▸ **create**(`discount`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Creates a discount with provided data given that the data is validated. +Normalizes discount code to uppercase. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discount` | [`CreateDiscountInput`](../modules/internal-8.md#creatediscountinput) | the discount data to create | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:74 + +___ + +### createDynamicCode + +▸ **createDynamicCode**(`discountId`, `data`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Creates a dynamic code for a discount id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | the id of the discount to create a code for | +| `data` | [`CreateDynamicDiscountInput`](../modules/internal-8.md#createdynamicdiscountinput) | the object containing a code to identify the discount by | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the newly created dynamic code + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:109 + +___ + +### delete + +▸ **delete**(`discountId`): `Promise`<`void`\> + +Deletes a discount idempotently + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | id of discount to delete | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:136 + +___ + +### deleteDynamicCode + +▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\> + +Deletes a dynamic code for a discount id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | the id of the discount to create a code for | +| `code` | `string` | the code to identify the discount by | + +#### Returns + +`Promise`<`void`\> + +the newly created dynamic code + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:116 + +___ + +### hasCustomersGroupCondition + +▸ **hasCustomersGroupCondition**(`discount`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:140 + +___ + +### hasExpired + +▸ **hasExpired**(`discount`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:143 + +___ + +### hasNotStarted + +▸ **hasNotStarted**(`discount`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:142 + +___ + +### hasReachedLimit + +▸ **hasReachedLimit**(`discount`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:141 + +___ + +### isDisabled + +▸ **isDisabled**(`discount`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:144 + +___ + +### isValidForRegion + +▸ **isValidForRegion**(`discount`, `region_id`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | +| `region_id` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:145 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Discount`](internal-3.Discount.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`FilterableDiscountProps`](internal-8.FilterableDiscountProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Discount`](internal-3.Discount.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:61 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Discount`](internal-3.Discount.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`FilterableDiscountProps`](internal-8.FilterableDiscountProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Discount`](internal-3.Discount.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[[`Discount`](internal-3.Discount.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:67 + +___ + +### listByCodes + +▸ **listByCodes**(`discountCodes`, `config?`): `Promise`<[`Discount`](internal-3.Discount.md)[]\> + +List all the discounts corresponding to the given codes + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountCodes` | `string`[] | discount codes of discounts to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Discount`](internal-3.Discount.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)[]\> + +the discounts + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:95 + +___ + +### removeRegion + +▸ **removeRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Removes a region from the discount regions array. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | id of discount | +| `regionId` | `string` | id of region to remove | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:130 + +___ + +### retrieve + +▸ **retrieve**(`discountId`, `config?`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Gets a discount by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | id of discount to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Discount`](internal-3.Discount.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the discount + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:81 + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Gets the discount by discount code. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountCode` | `string` | discount code of discount to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Discount`](internal-3.Discount.md)\> | the config object containing query settings | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the discount + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:88 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`discountId`, `update`): `Promise`<[`Discount`](internal-3.Discount.md)\> + +Updates a discount. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountId` | `string` | discount id of discount to update | +| `update` | [`UpdateDiscountInput`](../modules/internal-8.md#updatediscountinput) | the data to update the discount with | + +#### Returns + +`Promise`<[`Discount`](internal-3.Discount.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:102 + +___ + +### validateDiscountForCartOrThrow + +▸ **validateDiscountForCartOrThrow**(`cart`, `discount`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | +| `discount` | [`Discount`](internal-3.Discount.md) \| [`Discount`](internal-3.Discount.md)[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:139 + +___ + +### validateDiscountForProduct + +▸ **validateDiscountForProduct**(`discountRuleId`, `productId?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `discountRuleId` | `string` | +| `productId?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:137 + +___ + +### validateDiscountRule\_ + +▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T` + +Creates a discount rule with provided data given that the data is validated. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `Object` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discountRule` | `T` | the discount rule to create | + +#### Returns + +`T` + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/discount.d.ts:52 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DiscountService`](internal-8.internal.DiscountService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`DiscountService`](internal-8.internal.DiscountService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md new file mode 100644 index 0000000000..1dfac6f314 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.DraftOrderService.md @@ -0,0 +1,498 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: DraftOrderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).DraftOrderService + +Handles draft orders + +**`Implements`** + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`DraftOrderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cartService\_ + +• `Protected` `Readonly` **cartService\_**: [`CartService`](internal-8.internal.CartService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:40 + +___ + +### customShippingOptionService\_ + +• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:44 + +___ + +### draftOrderRepository\_ + +• `Protected` `Readonly` **draftOrderRepository\_**: `Repository`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:36 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:39 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:41 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### orderRepository\_ + +• `Protected` `Readonly` **orderRepository\_**: `Repository`<[`Order`](internal-3.Order.md)\> & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Order`](internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](internal-3.Order.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Order`](internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](internal-3.Order.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:38 + +___ + +### paymentRepository\_ + +• `Protected` `Readonly` **paymentRepository\_**: `Repository`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:37 + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:42 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:43 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:32 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +Creates a draft order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`DraftOrderCreateProps`](../modules/internal-8.md#draftordercreateprops) | data to create draft order from | + +#### Returns + +`Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +the created draft order + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:85 + +___ + +### delete + +▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| [`DraftOrder`](internal-3.DraftOrder.md)\> + +Deletes draft order idempotently. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `draftOrderId` | `string` | id of draft order to delete | + +#### Returns + +`Promise`<`undefined` \| [`DraftOrder`](internal-3.DraftOrder.md)\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:65 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`DraftOrder`](internal-3.DraftOrder.md)[]\> + +Lists draft orders + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `any` | query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`DraftOrder`](internal-3.DraftOrder.md)\> | configurable attributes for find | + +#### Returns + +`Promise`<[`DraftOrder`](internal-3.DraftOrder.md)[]\> + +list of draft orders + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:79 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`DraftOrder`](internal-3.DraftOrder.md)[], `number`]\> + +Lists draft orders alongside the count + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `any` | query selector to filter draft orders | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`DraftOrder`](internal-3.DraftOrder.md)\> | query config | + +#### Returns + +`Promise`<[[`DraftOrder`](internal-3.DraftOrder.md)[], `number`]\> + +draft orders + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:72 + +___ + +### registerCartCompletion + +▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\> + +Registers a draft order as completed, when an order has been completed. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `draftOrderId` | `string` | id of draft order to complete | +| `orderId` | `string` | id of order completed from draft order cart | + +#### Returns + +`Promise`<`UpdateResult`\> + +the created order + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:92 + +___ + +### retrieve + +▸ **retrieve**(`draftOrderId`, `config?`): `Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +Retrieves a draft order with the given id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `draftOrderId` | `string` | id of the draft order to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`DraftOrder`](internal-3.DraftOrder.md)\> | query object for findOne | + +#### Returns + +`Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +the draft order + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:52 + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +Retrieves a draft order based on its associated cart id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | cart id that the draft orders's cart has | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`DraftOrder`](internal-3.DraftOrder.md)\> | query object for findOne | + +#### Returns + +`Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +the draft order + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:59 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +Updates a draft order with the given data + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the draft order | +| `data` | `Object` | values to update the order with | +| `data.no_notification_order` | `boolean` | - | + +#### Returns + +`Promise`<[`DraftOrder`](internal-3.DraftOrder.md)\> + +the updated draft order + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:99 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`DraftOrderService`](internal-8.internal.DraftOrderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`DraftOrderService`](internal-8.internal.DraftOrderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md new file mode 100644 index 0000000000..c86e543d55 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.EmptyQueryParams.md @@ -0,0 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: EmptyQueryParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).EmptyQueryParams diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md new file mode 100644 index 0000000000..7f7a7a9b3d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.EventBusService.md @@ -0,0 +1,447 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: EventBusService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).EventBusService + +Can keep track of multiple subscribers to different events and run the +subscribers when events happen. Events will run asynchronously. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`EventBusService`** + +## Implements + +- [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### config\_ + +• `Protected` `Readonly` **config\_**: [`ConfigModule`](../modules/internal-8.md#configmodule) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:19 + +___ + +### enqueue\_ + +• `Protected` **enqueue\_**: `Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:24 + +___ + +### eventBusModuleService\_ + +• `Protected` `Readonly` **eventBusModuleService\_**: [`IEventBusModuleService`](../interfaces/internal-8.IEventBusModuleService.md) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:21 + +___ + +### logger\_ + +• `Protected` `Readonly` **logger\_**: [`Logger`](../interfaces/internal-8.Logger.md) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:22 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### shouldEnqueuerRun + +• `Protected` **shouldEnqueuerRun**: `boolean` + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:23 + +___ + +### stagedJobService\_ + +• `Protected` `Readonly` **stagedJobService\_**: [`StagedJobService`](internal-8.internal.StagedJobService.md) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:20 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### emit + +▸ **emit**<`T`\>(`data`): `Promise`<`void` \| [`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +Calls all subscribers when an event occurs. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`EmitData`](../modules/internal-8.md#emitdata)<`T`\>[] | The data to use to process the events | + +#### Returns + +`Promise`<`void` \| [`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +the jobs from our queue + +#### Implementation of + +[IEventBusService](../interfaces/internal-8.IEventBusService.md).[emit](../interfaces/internal-8.IEventBusService.md#emit) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:49 + +▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| [`StagedJob`](internal-8.internal.StagedJob.md)\> + +Calls all subscribers when an event occurs. + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` | the name of the event to be process. | +| `data` | `T` | the data to send to the subscriber. | +| `options?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | options to add the job with | + +#### Returns + +`Promise`<`void` \| [`StagedJob`](internal-8.internal.StagedJob.md)\> + +the job from our queue + +#### Implementation of + +EventBusTypes.IEventBusService.emit + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:57 + +___ + +### enqueuer\_ + +▸ **enqueuer_**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:60 + +___ + +### listJobs + +▸ `Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| [`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `listConfig` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`StagedJob`](internal-8.internal.StagedJob.md)\> | + +#### Returns + +`Promise`<`never`[] \| [`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:61 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### startEnqueuer + +▸ **startEnqueuer**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:58 + +___ + +### stopEnqueuer + +▸ **stopEnqueuer**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:59 + +___ + +### subscribe + +▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](internal-8.internal.EventBusService.md) + +Adds a function to a list of event subscribers. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | `string` \| `symbol` | the event that the subscriber will listen for. | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber)<`unknown`\> | the function to be called when a certain event happens. Subscribers must return a Promise. | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | subscriber context | + +#### Returns + +[`EventBusService`](internal-8.internal.EventBusService.md) + +this + +#### Implementation of + +[IEventBusService](../interfaces/internal-8.IEventBusService.md).[subscribe](../interfaces/internal-8.IEventBusService.md#subscribe) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:35 + +___ + +### unsubscribe + +▸ **unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](internal-8.internal.EventBusService.md) + +Removes function from the list of event subscribers. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | `string` \| `symbol` | the event of the subcriber. | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber)<`unknown`\> | the function to be removed | +| `context` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | subscriber context | + +#### Returns + +[`EventBusService`](internal-8.internal.EventBusService.md) + +this + +#### Implementation of + +[IEventBusService](../interfaces/internal-8.IEventBusService.md).[unsubscribe](../interfaces/internal-8.IEventBusService.md#unsubscribe) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:43 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`EventBusService`](internal-8.internal.EventBusService.md) + +#### Implementation of + +[IEventBusService](../interfaces/internal-8.IEventBusService.md).[withTransaction](../interfaces/internal-8.IEventBusService.md#withtransaction) + +#### Overrides + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:26 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md new file mode 100644 index 0000000000..2c6dabf5c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterableBatchJobProps.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FilterableBatchJobProps + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FilterableBatchJobProps + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:33 + +___ + +### created\_by + +• `Optional` **created\_by**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:32 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:29 + +___ + +### status + +• `Optional` **status**: [`BatchJobStatus`](../enums/internal-2.BatchJobStatus.md)[] + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:30 + +___ + +### type + +• `Optional` **type**: `string`[] + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:31 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:34 diff --git a/www/apps/docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md similarity index 55% rename from www/apps/docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md index 72ba16f006..6c49d01a9f 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-17.FilterablePriceListProps.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FilterablePriceListProps.md @@ -1,12 +1,16 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: FilterablePriceListProps -[internal](../modules/internal-17.md).FilterablePriceListProps +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FilterablePriceListProps ## Hierarchy - **`FilterablePriceListProps`** - ↳ [`AdminGetPriceListPaginationParams`](internal-17.AdminGetPriceListPaginationParams.md) + ↳ [`AdminGetPriceListPaginationParams`](internal-8.internal.AdminGetPriceListPaginationParams.md) ## Properties @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/types/price-list.d.ts:19 +packages/medusa/dist/types/price-list.d.ts:19 ___ @@ -26,7 +30,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:16 +packages/medusa/dist/types/price-list.d.ts:16 ___ @@ -36,7 +40,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:21 +packages/medusa/dist/types/price-list.d.ts:21 ___ @@ -46,7 +50,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:17 +packages/medusa/dist/types/price-list.d.ts:17 ___ @@ -56,7 +60,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:12 +packages/medusa/dist/types/price-list.d.ts:12 ___ @@ -66,7 +70,7 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:15 +packages/medusa/dist/types/price-list.d.ts:15 ___ @@ -76,27 +80,27 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:13 +packages/medusa/dist/types/price-list.d.ts:13 ___ ### status -• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[] +• `Optional` **status**: [`PriceListStatus`](../enums/internal-3.PriceListStatus.md)[] #### Defined in -medusa/dist/types/price-list.d.ts:14 +packages/medusa/dist/types/price-list.d.ts:14 ___ ### type -• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[] +• `Optional` **type**: [`PriceListType`](../enums/internal-3.PriceListType.md)[] #### Defined in -medusa/dist/types/price-list.d.ts:18 +packages/medusa/dist/types/price-list.d.ts:18 ___ @@ -106,4 +110,4 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:20 +packages/medusa/dist/types/price-list.d.ts:20 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md new file mode 100644 index 0000000000..e04cb2db5e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentOption.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentOption + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FulfillmentOption + +## Properties + +### options + +• **options**: `unknown`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:90 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:89 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md new file mode 100644 index 0000000000..d05b712d27 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md @@ -0,0 +1,459 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: FulfillmentProviderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FulfillmentProviderService + +Helps retrieve fulfillment providers + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`FulfillmentProviderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### container\_ + +• `Protected` `Readonly` **container\_**: [`FulfillmentProviderContainer`](../modules/internal-8.md#fulfillmentprovidercontainer) + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:24 + +___ + +### fulfillmentProviderRepository\_ + +• `Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<[`FulfillmentProvider`](internal-3.FulfillmentProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:25 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### calculatePrice + +▸ **calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `cart?` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:39 + +___ + +### canCalculate + +▸ **canCalculate**(`option`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `option` | [`CalculateOptionPriceInput`](../modules/internal-8.md#calculateoptionpriceinput) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:36 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillment`): `Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillment` | [`Fulfillment`](internal-3.Fulfillment.md) | + +#### Returns + +`Promise`<[`Fulfillment`](internal-3.Fulfillment.md)\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:38 + +___ + +### createFulfillment + +▸ **createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `method` | [`ShippingMethod`](internal-3.ShippingMethod.md) | +| `items` | [`LineItem`](internal-3.LineItem.md)[] | +| `order` | [`CreateFulfillmentOrder`](../modules/internal-8.md#createfulfillmentorder) | +| `fulfillment` | [`Omit`](../modules/internal-1.md#omit)<[`Fulfillment`](internal-3.Fulfillment.md), ``"beforeInsert"``\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:35 + +___ + +### createReturn + +▸ **createReturn**(`returnOrder`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnOrder` | [`CreateReturnType`](../modules/internal-8.md#createreturntype) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:41 + +___ + +### list + +▸ **list**(): `Promise`<[`FulfillmentProvider`](internal-3.FulfillmentProvider.md)[]\> + +#### Returns + +`Promise`<[`FulfillmentProvider`](internal-3.FulfillmentProvider.md)[]\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:28 + +___ + +### listFulfillmentOptions + +▸ **listFulfillmentOptions**(`providerIds`): `Promise`<[`FulfillmentOptions`](../modules/internal-8.md#fulfillmentoptions)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providerIds` | `string`[] | + +#### Returns + +`Promise`<[`FulfillmentOptions`](../modules/internal-8.md#fulfillmentoptions)[]\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:29 + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providers` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:27 + +___ + +### retrieveDocuments + +▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\> + +Fetches documents from the fulfillment provider + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `providerId` | `string` | the id of the provider | +| `fulfillmentData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the data relating to the fulfillment | +| `documentType` | ``"label"`` \| ``"invoice"`` | the typ of | + +#### Returns + +`Promise`<`any`\> + +document to fetch + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:49 + +___ + +### retrieveProvider + +▸ **retrieveProvider**(`providerId`): `any` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `providerId` | `string` | the provider id | + +#### Returns + +`any` + +the payment fulfillment provider + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:34 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### validateFulfillmentData + +▸ **validateFulfillmentData**(`option`, `data`, `cart`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `cart` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:37 + +___ + +### validateOption + +▸ **validateOption**(`option`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:40 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md new file mode 100644 index 0000000000..89830487d5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsOrderEditParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GetOrderEditsOrderEditParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetOrderEditsOrderEditParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`GetOrderEditsOrderEditParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md similarity index 57% rename from www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md index f88df55ac8..b4f07f1251 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-13.GetOrderEditsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetOrderEditsParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: GetOrderEditsParams -[internal](../modules/internal-13.md).GetOrderEditsParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetOrderEditsParams ## Hierarchy -- [`GetOrderEditsParams_base`](../modules/internal-13.md#getordereditsparams_base) +- [`GetOrderEditsParams_base`](../modules/internal-8.md#getordereditsparams_base) ↳ **`GetOrderEditsParams`** @@ -20,7 +24,7 @@ GetOrderEditsParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -34,7 +38,7 @@ GetOrderEditsParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 ___ @@ -48,7 +52,7 @@ GetOrderEditsParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -62,7 +66,7 @@ GetOrderEditsParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -72,7 +76,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:74 +packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:65 ___ @@ -82,4 +86,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:73 +packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:64 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md new file mode 100644 index 0000000000..40e9c24c6d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPaymentsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GetPaymentsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetPaymentsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`GetPaymentsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md new file mode 100644 index 0000000000..8fffbc8ccc --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md @@ -0,0 +1,79 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GetPublishableApiKeySalesChannelsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetPublishableApiKeySalesChannelsParams + +## Hierarchy + +- [`GetPublishableApiKeySalesChannelsParams_base`](../modules/internal-8.md#getpublishableapikeysaleschannelsparams_base) + + ↳ **`GetPublishableApiKeySalesChannelsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +GetPublishableApiKeySalesChannelsParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +GetPublishableApiKeySalesChannelsParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +GetPublishableApiKeySalesChannelsParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +GetPublishableApiKeySalesChannelsParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.d.ts:60 diff --git a/www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md similarity index 57% rename from www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md index 10ebffc9ff..e73e84931f 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-21.GetPublishableApiKeysParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GetPublishableApiKeysParams.md @@ -1,10 +1,14 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: GetPublishableApiKeysParams -[internal](../modules/internal-21.md).GetPublishableApiKeysParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GetPublishableApiKeysParams ## Hierarchy -- [`GetPublishableApiKeysParams_base`](../modules/internal-21.md#getpublishableapikeysparams_base) +- [`GetPublishableApiKeysParams_base`](../modules/internal-8.md#getpublishableapikeysparams_base) ↳ **`GetPublishableApiKeysParams`** @@ -20,7 +24,7 @@ GetPublishableApiKeysParams\_base.expand #### Defined in -medusa/dist/types/common.d.ts:117 +packages/medusa/dist/types/common.d.ts:239 ___ @@ -34,7 +38,7 @@ GetPublishableApiKeysParams\_base.fields #### Defined in -medusa/dist/types/common.d.ts:118 +packages/medusa/dist/types/common.d.ts:240 ___ @@ -48,7 +52,7 @@ GetPublishableApiKeysParams\_base.limit #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -62,7 +66,7 @@ GetPublishableApiKeysParams\_base.offset #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -72,4 +76,4 @@ ___ #### Defined in -medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:63 +packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:63 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md new file mode 100644 index 0000000000..314f0176e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.GiftCardService.md @@ -0,0 +1,496 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: GiftCardService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).GiftCardService + +Provides layer to manipulate gift cards. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`GiftCardService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:24 + +___ + +### giftCardRepository\_ + +• `Protected` `Readonly` **giftCardRepository\_**: `Repository`<[`GiftCard`](internal-3.GiftCard.md)\> & { `listGiftCardsAndCount`: (`query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`GiftCard`](internal-3.GiftCard.md)\>, `q?`: `string`) => `Promise`<[[`GiftCard`](internal-3.GiftCard.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:21 + +___ + +### giftCardTransactionRepo\_ + +• `Protected` `Readonly` **giftCardTransactionRepo\_**: `Repository`<[`GiftCardTransaction`](internal-3.GiftCardTransaction.md)\> + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:22 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:23 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:25 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`giftCard`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +Creates a gift card with provided data given that the data is validated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `giftCard` | [`CreateGiftCardInput`](../modules/internal-8.md#creategiftcardinput) | the gift card data to create | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:52 + +___ + +### createTransaction + +▸ **createTransaction**(`data`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateGiftCardTransactionInput`](../modules/internal-8.md#creategiftcardtransactioninput) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:46 + +___ + +### delete + +▸ **delete**(`giftCardId`): `Promise`<`void` \| [`GiftCard`](internal-3.GiftCard.md)\> + +Deletes a gift card idempotently + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `giftCardId` | `string` | id of gift card to delete | + +#### Returns + +`Promise`<`void` \| [`GiftCard`](internal-3.GiftCard.md)\> + +the result of the delete operation + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:80 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`GiftCard`](internal-3.GiftCard.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`GiftCard`](internal-3.GiftCard.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:45 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`GiftCard`](internal-3.GiftCard.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`GiftCard`](internal-3.GiftCard.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`GiftCard`](internal-3.GiftCard.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[[`GiftCard`](internal-3.GiftCard.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:39 + +___ + +### retrieve + +▸ **retrieve**(`giftCardId`, `config?`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +Gets a gift card by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `giftCardId` | `string` | id of gift card to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`GiftCard`](internal-3.GiftCard.md)\> | optional values to include with gift card query | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +the gift card + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:66 + +___ + +### retrieveByCode + +▸ **retrieveByCode**(`code`, `config?`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`GiftCard`](internal-3.GiftCard.md)\> | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:67 + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`GiftCard`](internal-3.GiftCard.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`GiftCard`](internal-3.GiftCard.md)\> | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:59 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`giftCardId`, `update`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +Updates a giftCard. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `giftCardId` | `string` | giftCard id of giftCard to update | +| `update` | [`UpdateGiftCardInput`](../modules/internal-8.md#updategiftcardinput) | the data to update the giftCard with | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:74 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`GiftCardService`](internal-8.internal.GiftCardService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`GiftCardService`](internal-8.internal.GiftCardService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 + +___ + +### generateCode + +▸ `Static` **generateCode**(): `string` + +Generates a 16 character gift card code + +#### Returns + +`string` + +the generated gift card code + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:33 + +___ + +### resolveTaxRate + +▸ `Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number` + +The tax_rate of the giftcard can depend on whether regions tax gift cards, an input +provided by the user or the tax rate. Based on these conditions, tax_rate changes. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `giftCardTaxRate` | ``null`` \| `number` | +| `region` | [`Region`](internal-3.Region.md) | + +#### Returns + +``null`` \| `number` + +the tax rate for the gift card + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:58 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md new file mode 100644 index 0000000000..6d71473a6a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IAdminPostUploadsFileReq.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: IAdminPostUploadsFileReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IAdminPostUploadsFileReq + +## Properties + +### originalName + +• **originalName**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:64 + +___ + +### path + +• **path**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/create-upload.d.ts:65 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md new file mode 100644 index 0000000000..6d038f85b2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKey.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: IdempotencyKey + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IdempotencyKey + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:12 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:4 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:2 + +___ + +### idempotency\_key + +• **idempotency\_key**: `string` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:3 + +___ + +### locked\_at + +• **locked\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:5 + +___ + +### recovery\_point + +• **recovery\_point**: `string` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:11 + +___ + +### request\_method + +• **request\_method**: `string` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:6 + +___ + +### request\_params + +• **request\_params**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:7 + +___ + +### request\_path + +• **request\_path**: `string` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:8 + +___ + +### response\_body + +• **response\_body**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:10 + +___ + +### response\_code + +• **response\_code**: `number` + +#### Defined in + +packages/medusa/dist/models/idempotency-key.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md new file mode 100644 index 0000000000..dc1561ba2e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.IdempotencyKeyService.md @@ -0,0 +1,353 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: IdempotencyKeyService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IdempotencyKeyService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`IdempotencyKeyService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### idempotencyKeyRepository\_ + +• `Protected` `Readonly` **idempotencyKeyRepository\_**: `Repository`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:12 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`payload`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Creates an idempotency key for a request. +If no idempotency key is provided in request, we will create a unique +identifier. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `payload` | [`CreateIdempotencyKeyInput`](../modules/internal-8.md#createidempotencykeyinput) | payload of request to create idempotency key for | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +the created idempotency key + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:30 + +___ + +### initializeRequest + +▸ **initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Execute the initial steps in a idempotent request. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `headerKey` | `string` | potential idempotency key from header | +| `reqMethod` | `string` | method of request | +| `reqParams` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | params of request | +| `reqPath` | `string` | path of request | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +the existing or created idempotency key + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:22 + +___ + +### lock + +▸ **lock**(`idempotencyKey`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Locks an idempotency. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idempotencyKey` | `string` | key to lock | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +result of the update operation + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:42 + +___ + +### retrieve + +▸ **retrieve**(`idempotencyKeyOrSelector`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Retrieves an idempotency key + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idempotencyKeyOrSelector` | `string` \| [`Selector`](../modules/internal-8.internal.md#selector)<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> | key or selector to retrieve | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +idempotency key + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:36 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`idempotencyKey`, `update`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Locks an idempotency. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idempotencyKey` | `string` | key to update | +| `update` | `DeepPartial`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> | update object | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +result of the update operation + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:49 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IdempotencyKeyService`](internal-8.internal.IdempotencyKeyService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`IdempotencyKeyService`](internal-8.internal.IdempotencyKeyService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 + +___ + +### workStage + +▸ **workStage**(`idempotencyKey`, `callback`): `Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +Performs an atomic work stage. +An atomic work stage contains some related functionality, that needs to be +transactionally executed in isolation. An idempotent request will +always consist of 2 or more of these phases. The required phases are +"started" and "finished". + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idempotencyKey` | `string` | current idempotency key | +| `callback` | (`transactionManager`: `EntityManager`) => `Promise`<[`IdempotencyCallbackResult`](../modules/internal-8.md#idempotencycallbackresult)\> | functionality to execute within the phase | + +#### Returns + +`Promise`<[`IdempotencyKey`](internal-8.internal.IdempotencyKey.md)\> + +new updated idempotency key + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:60 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md new file mode 100644 index 0000000000..21868e75a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Invite.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Invite + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Invite + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Invite`** + +## Properties + +### accepted + +• **accepted**: `boolean` + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:6 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:10 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### expires\_at + +• **expires\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:8 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:9 + +___ + +### role + +• **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:5 + +___ + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### user\_email + +• **user\_email**: `string` + +#### Defined in + +packages/medusa/dist/models/invite.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md new file mode 100644 index 0000000000..69635257bb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Item.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Item + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Item + +## Properties + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:55 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:54 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md new file mode 100644 index 0000000000..1e2e2815d3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemAdjustmentService.md @@ -0,0 +1,410 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemAdjustmentService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).LineItemAdjustmentService + +Provides layer to manipulate line item adjustments. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`LineItemAdjustmentService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### discountService + +• `Private` `Readonly` **discountService**: `any` + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:29 + +___ + +### lineItemAdjustmentRepo\_ + +• `Private` `Readonly` **lineItemAdjustmentRepo\_**: `any` + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:28 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +Creates a line item adjustment + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`Partial`](../modules/internal-8.md#partial)<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> | the line item adjustment to create | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +line item adjustment + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:43 + +___ + +### createAdjustmentForLineItem + +▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart object holding discounts | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[]\> + +a line item adjustment or undefined if no adjustment was created + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:80 + +___ + +### createAdjustments + +▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[] \| [`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[][]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart object holding discounts | +| `lineItem?` | [`LineItem`](internal-3.LineItem.md) | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[] \| [`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[][]\> + +if a lineItem was given, returns a line item adjustment or undefined if no adjustment was created +otherwise returns an array of line item adjustments for each line item in the cart + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:88 + +___ + +### delete + +▸ **delete**(`selectorOrIds`): `Promise`<`void`\> + +Deletes line item adjustments matching a selector + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selectorOrIds` | `string` \| `string`[] \| [`FilterableLineItemAdjustmentProps`](internal-8.FilterableLineItemAdjustmentProps.md) & { `discount_id?`: `FindOperator`<``null`` \| `string`\> } | the query object for find or the line item adjustment id | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:63 + +___ + +### generateAdjustments + +▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<[`GeneratedAdjustment`](../modules/internal-8.md#generatedadjustment)[]\> + +Creates adjustment for a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `calculationContextData` | [`CalculationContextData`](../modules/internal-8.md#calculationcontextdata) | the calculationContextData object holding discounts | +| `generatedLineItem` | [`LineItem`](internal-3.LineItem.md) | the line item for which a line item adjustment might be created | +| `context` | [`AdjustmentContext`](../modules/internal-8.md#adjustmentcontext) | the line item for which a line item adjustment might be created | + +#### Returns + +`Promise`<[`GeneratedAdjustment`](../modules/internal-8.md#generatedadjustment)[]\> + +a line item adjustment or undefined if no adjustment was created + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:73 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[]\> + +Lists line item adjustments + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`FilterableLineItemAdjustmentProps`](internal-8.FilterableLineItemAdjustmentProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:57 + +___ + +### retrieve + +▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +Retrieves a line item adjustment by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItemAdjustmentId` | `string` | the id of the line item adjustment to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> | the config to retrieve the line item adjustment by | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +the line item adjustment. + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:37 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +Creates a line item adjustment + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the line item adjustment id to update | +| `data` | [`Partial`](../modules/internal-8.md#partial)<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> | the line item adjustment to create | + +#### Returns + +`Promise`<[`LineItemAdjustment`](internal-3.LineItemAdjustment.md)\> + +line item adjustment + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:50 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md new file mode 100644 index 0000000000..61c3550722 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.LineItemService.md @@ -0,0 +1,605 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: LineItemService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).LineItemService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`LineItemService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cartRepository\_ + +• `Protected` `Readonly` **cartRepository\_**: `Repository`<[`Cart`](internal-3.Cart.md)\> & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:30 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:35 + +___ + +### itemTaxLineRepo\_ + +• `Protected` `Readonly` **itemTaxLineRepo\_**: `Repository`<[`LineItemTaxLine`](internal-3.LineItemTaxLine.md)\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: [`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[]) => `Promise`<[`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:29 + +___ + +### lineItemAdjustmentService\_ + +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:36 + +___ + +### lineItemRepository\_ + +• `Protected` `Readonly` **lineItemRepository\_**: `Repository`<[`LineItem`](internal-3.LineItem.md)\> & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](internal-3.ReturnItem.md) }[]\> } + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:28 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### pricingService\_ + +• `Protected` `Readonly` **pricingService\_**: [`PricingService`](internal-8.internal.PricingService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:33 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:32 + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:31 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:34 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:37 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cloneTo + +▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `ids` | `string` \| `string`[] | +| `data?` | `DeepPartial`<[`LineItem`](internal-3.LineItem.md)\> | +| `options?` | `Object` | +| `options.setOriginalLineItemId?` | `boolean` | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:108 + +___ + +### create + +▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> + +Create a line item + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | [`LineItem`](internal-3.LineItem.md) \| [`LineItem`](internal-3.LineItem.md)[] | +| `TResult` | `T` extends [`LineItem`](internal-3.LineItem.md)[] ? [`LineItem`](internal-3.LineItem.md)[] : [`LineItem`](internal-3.LineItem.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `T` | the line item object to create | + +#### Returns + +`Promise`<`TResult`\> + +the created line item + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:81 + +___ + +### createReturnLines + +▸ **createReturnLines**(`returnId`, `cartId`): `Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +Creates return line items for a given cart based on the return items in a +return. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `returnId` | `string` | the id to generate return items from. | +| `cartId` | `string` | the cart to assign the return line items to. | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +the created line items + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:54 + +___ + +### createTaxLine + +▸ **createTaxLine**(`args`): [`LineItemTaxLine`](internal-3.LineItemTaxLine.md) + +Create a line item tax line. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `args` | `DeepPartial`<[`LineItemTaxLine`](internal-3.LineItemTaxLine.md)\> | tax line partial passed to the repo create method | + +#### Returns + +[`LineItemTaxLine`](internal-3.LineItemTaxLine.md) + +a new line item tax line + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:107 + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](internal-3.LineItem.md)\> + +Deletes a line item. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the line item to delete | + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`LineItem`](internal-3.LineItem.md)\> + +the result of the delete operation + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:94 + +___ + +### deleteWithTaxLines + +▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](internal-3.LineItem.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the line item to delete | + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`LineItem`](internal-3.LineItem.md)\> + +the result of the delete operation + +**`Deprecated`** + +no the cascade on the entity takes care of it +Deletes a line item with the tax lines. + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:101 + +___ + +### generate + +▸ **generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\> + +Generate a single or multiple line item without persisting the data into the db + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `string` \| [`GenerateInputData`](../modules/internal-8.md#generateinputdata) \| [`GenerateInputData`](../modules/internal-8.md#generateinputdata)[] | +| `TResult` | `T` extends `string` ? [`LineItem`](internal-3.LineItem.md) : `T` extends [`LineItem`](internal-3.LineItem.md) ? [`LineItem`](internal-3.LineItem.md) : [`LineItem`](internal-3.LineItem.md)[] | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variantIdOrData` | `T` | +| `regionIdOrContext` | `T` extends `string` ? `string` : [`GenerateLineItemContext`](../modules/internal-8.md#generatelineitemcontext) | +| `quantity?` | `number` | +| `context?` | [`GenerateLineItemContext`](../modules/internal-8.md#generatelineitemcontext) | + +#### Returns + +`Promise`<`TResult`\> + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:62 + +___ + +### generateLineItem + +▸ `Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<[`LineItem`](internal-3.LineItem.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variant` | `Object` | +| `variant.id` | `string` | +| `variant.product` | `Object` | +| `variant.product.discountable` | `boolean` | +| `variant.product.is_giftcard` | `boolean` | +| `variant.product.thumbnail` | ``null`` \| `string` | +| `variant.product.title` | `string` | +| `variant.product_id` | `string` | +| `variant.title` | `string` | +| `quantity` | `number` | +| `context` | [`GenerateLineItemContext`](../modules/internal-8.md#generatelineitemcontext) & { `variantPricing`: [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing) } | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)\> + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:63 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`LineItem`](internal-3.LineItem.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`LineItem`](internal-3.LineItem.md)\> | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:39 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`LineItem`](internal-3.LineItem.md)\> + +Retrieves a line item by its id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the line item to retrieve | +| `config?` | `Object` | the config to be used at query building | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)\> + +the line item + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:46 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`idOrSelector`, `data`): `Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +Updates a line item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `idOrSelector` | `string` \| [`Selector`](../modules/internal-8.internal.md#selector)<[`LineItem`](internal-3.LineItem.md)\> | the id or selector of the line item(s) to update | +| `data` | [`Partial`](../modules/internal-8.md#partial)<[`LineItem`](internal-3.LineItem.md)\> | the properties to update the line item(s) | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +the updated line item(s) + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:88 + +___ + +### validateGenerateArguments + +▸ `Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `string` \| [`GenerateInputData`](../modules/internal-8.md#generateinputdata) \| [`GenerateInputData`](../modules/internal-8.md#generateinputdata)[] | +| `TResult` | `T` extends `string` ? [`LineItem`](internal-3.LineItem.md) : `T` extends [`LineItem`](internal-3.LineItem.md) ? [`LineItem`](internal-3.LineItem.md) : [`LineItem`](internal-3.LineItem.md)[] | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variantIdOrData` | `string` \| `T` | +| `regionIdOrContext` | `T` extends `string` ? `string` : [`GenerateLineItemContext`](../modules/internal-8.md#generatelineitemcontext) | +| `quantity?` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:111 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`LineItemService`](internal-8.internal.LineItemService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md new file mode 100644 index 0000000000..0b24bff318 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.MiddlewareService.md @@ -0,0 +1,244 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: MiddlewareService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).MiddlewareService + +Orchestrates dynamic middleware registered through the Medusa Middleware API + +## Properties + +### postAuthentication\_ + +• `Protected` `Readonly` **postAuthentication\_**: [`middlewareType`](../modules/internal-8.md#middlewaretype)[] + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:11 + +___ + +### preAuthentication\_ + +• `Protected` `Readonly` **preAuthentication\_**: [`middlewareType`](../modules/internal-8.md#middlewaretype)[] + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:12 + +___ + +### preCartCreation\_ + +• `Protected` `Readonly` **preCartCreation\_**: `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](../modules/internal.md#record)<`string`, `any`\>\>[] + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:13 + +___ + +### routers + +• `Protected` `Readonly` **routers**: [`Record`](../modules/internal.md#record)<`string`, `Router`[]\> + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:14 + +## Methods + +### addPostAuthentication + +▸ **addPostAuthentication**(`middleware`, `options`): `void` + +Adds a middleware function to be called after authentication is completed. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `middleware` | [`middlewareHandlerType`](../modules/internal-8.md#middlewarehandlertype) | the middleware function. Should return a middleware function. | +| `options` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the arguments that will be passed to the middleware | + +#### Returns + +`void` + +void + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:32 + +___ + +### addPreAuthentication + +▸ **addPreAuthentication**(`middleware`, `options`): `void` + +Adds a middleware function to be called before authentication is completed. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `middleware` | [`middlewareHandlerType`](../modules/internal-8.md#middlewarehandlertype) | the middleware function. Should return a middleware function. | +| `options` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the arguments that will be passed to the middleware | + +#### Returns + +`void` + +void + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:41 + +___ + +### addPreCartCreation + +▸ **addPreCartCreation**(`middleware`): `void` + +Adds a middleware function to be called before cart creation + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `middleware` | `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](../modules/internal.md#record)<`string`, `any`\>\> | the middleware function. Should return a middleware function. | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:48 + +___ + +### addRouter + +▸ **addRouter**(`path`, `router`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | +| `router` | `Router` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:16 + +___ + +### getRouters + +▸ **getRouters**(`path`): `Router`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `path` | `string` | + +#### Returns + +`Router`[] + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:17 + +___ + +### usePostAuthentication + +▸ **usePostAuthentication**(`app`): `void` + +Adds post authentication middleware to an express app. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `app` | `Router` | the express app to add the middleware to | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:54 + +___ + +### usePreAuthentication + +▸ **usePreAuthentication**(`app`): `void` + +Adds pre authentication middleware to an express app. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `app` | `Router` | the express app to add the middleware to | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:60 + +___ + +### usePreCartCreation + +▸ **usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](../modules/internal.md#record)<`string`, `any`\>\>[] + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](../modules/internal.md#record)<`string`, `any`\>\>[] + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:61 + +___ + +### validateMiddleware\_ + +▸ **validateMiddleware_**(`fn`): `void` + +Validates a middleware function, throws if fn is not of type function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fn` | `unknown` | the middleware function to validate. | + +#### Returns + +`void` + +nothing if the middleware is a function + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:23 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md new file mode 100644 index 0000000000..41a70ee561 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NewTotalsService.md @@ -0,0 +1,495 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NewTotalsService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).NewTotalsService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`NewTotalsService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:42 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### taxCalculationStrategy\_ + +• `Protected` `Readonly` **taxCalculationStrategy\_**: [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:43 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:41 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### getGiftCardTotals + +▸ **getGiftCardTotals**(`giftCardableAmount`, `«destructured»`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +Calculate and return the gift cards totals + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `giftCardableAmount` | `number` | +| `«destructured»` | `Object` | +| › `giftCardTransactions?` | [`GiftCardTransaction`](../modules/internal-8.md#giftcardtransaction)[] | +| › `giftCards?` | [`GiftCard`](internal-3.GiftCard.md)[] | +| › `region` | [`Region`](internal-3.Region.md) | + +#### Returns + +`Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:123 + +___ + +### getGiftCardTransactionsTotals + +▸ **getGiftCardTransactionsTotals**(`«destructured»`): `Object` + +Calculate and return the gift cards totals based on their transactions + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `giftCardTransactions` | [`GiftCardTransaction`](../modules/internal-8.md#giftcardtransaction)[] | +| › `region` | `Object` | +| › `region.gift_cards_taxable` | `boolean` | +| › `region.tax_rate` | `number` | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `tax_total` | `number` | +| `total` | `number` | + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:136 + +___ + +### getLineItemRefund + +▸ **getLineItemRefund**(`lineItem`, `«destructured»`): `number` + +Return the amount that can be refund on a line item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lineItem` | `Object` | +| `lineItem.id` | `string` | +| `lineItem.includes_tax` | `boolean` | +| `lineItem.quantity` | `number` | +| `lineItem.tax_lines` | [`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[] | +| `lineItem.unit_price` | `number` | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `taxRate?` | ``null`` \| `number` | + +#### Returns + +`number` + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:91 + +___ + +### getLineItemRefundLegacy + +▸ `Protected` **getLineItemRefundLegacy**(`lineItem`, `«destructured»`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lineItem` | `Object` | +| `lineItem.id` | `string` | +| `lineItem.includes_tax` | `boolean` | +| `lineItem.quantity` | `number` | +| `lineItem.unit_price` | `number` | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `taxRate` | `number` | + +#### Returns + +`number` + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:107 + +___ + +### getLineItemTotals + +▸ **getLineItemTotals**(`items`, `«destructured»`): `Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../modules/internal-8.md#lineitemtotals); }\> + +Calculate and return the items totals for either the legacy calculation or the new calculation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `items` | [`LineItem`](internal-3.LineItem.md) \| [`LineItem`](internal-3.LineItem.md)[] | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `includeTax?` | `boolean` | +| › `taxRate?` | ``null`` \| `number` | + +#### Returns + +`Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../modules/internal-8.md#lineitemtotals); }\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:52 + +___ + +### getLineItemTotalsLegacy + +▸ `Protected` **getLineItemTotalsLegacy**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals)\> + +Calculate and return the legacy calculated totals using the tax rate + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`LineItem`](internal-3.LineItem.md) | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `lineItemAllocation` | `Object` | +| › `lineItemAllocation.discount?` | [`DiscountAllocation`](../modules/internal-8.md#discountallocation) | +| › `lineItemAllocation.gift_card?` | [`GiftCardAllocation`](../modules/internal-8.md#giftcardallocation) | +| › `taxRate` | `number` | + +#### Returns + +`Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals)\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:80 + +___ + +### getLineItemTotals\_ + +▸ `Protected` **getLineItemTotals_**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals)\> + +Calculate and return the totals for an item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `item` | [`LineItem`](internal-3.LineItem.md) | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `includeTax?` | `boolean` | +| › `lineItemAllocation` | `Object` | +| › `lineItemAllocation.discount?` | [`DiscountAllocation`](../modules/internal-8.md#discountallocation) | +| › `lineItemAllocation.gift_card?` | [`GiftCardAllocation`](../modules/internal-8.md#giftcardallocation) | +| › `taxLines?` | [`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[] | + +#### Returns + +`Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals)\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:67 + +___ + +### getShippingMethodTotals + +▸ **getShippingMethodTotals**(`shippingMethods`, `«destructured»`): `Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals); }\> + +Calculate and return the shipping methods totals for either the legacy calculation or the new calculation + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `shippingMethods` | [`ShippingMethod`](internal-3.ShippingMethod.md) \| [`ShippingMethod`](internal-3.ShippingMethod.md)[] | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `discounts?` | [`Discount`](internal-3.Discount.md)[] | +| › `includeTax?` | `boolean` | +| › `taxRate?` | ``null`` \| `number` | + +#### Returns + +`Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals); }\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:154 + +___ + +### getShippingMethodTotalsLegacy + +▸ `Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals)\> + +Calculate and return the shipping method totals legacy using the tax rate + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `shippingMethod` | [`ShippingMethod`](internal-3.ShippingMethod.md) | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `discounts?` | [`Discount`](internal-3.Discount.md)[] | +| › `taxRate` | `number` | + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals)\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:183 + +___ + +### getShippingMethodTotals\_ + +▸ `Protected` **getShippingMethodTotals_**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals)\> + +Calculate and return the shipping method totals + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `shippingMethod` | [`ShippingMethod`](internal-3.ShippingMethod.md) | +| `«destructured»` | `Object` | +| › `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | +| › `discounts?` | [`Discount`](internal-3.Discount.md)[] | +| › `includeTax?` | `boolean` | +| › `taxLines?` | [`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[] | + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals)\> + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:170 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md new file mode 100644 index 0000000000..c9b00c295a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Note.md @@ -0,0 +1,141 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Note + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Note + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`Note`** + +## Properties + +### author + +• **author**: [`User`](internal-1.User.md) + +#### Defined in + +packages/medusa/dist/models/note.d.ts:8 + +___ + +### author\_id + +• **author\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/note.d.ts:7 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/note.d.ts:10 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/note.d.ts:9 + +___ + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/note.d.ts:6 + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/models/note.d.ts:5 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/models/note.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md new file mode 100644 index 0000000000..ce208aec0b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NoteService.md @@ -0,0 +1,374 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NoteService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).NoteService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`NoteService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/note.d.ts:20 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### noteRepository\_ + +• `Protected` `Readonly` **noteRepository\_**: `Repository`<[`Note`](internal-8.internal.Note.md)\> + +#### Defined in + +packages/medusa/dist/services/note.d.ts:19 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/note.d.ts:14 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`, `config?`): `Promise`<[`Note`](internal-8.internal.Note.md)\> + +Creates a note associated with a given author + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreateNoteInput`](../interfaces/internal-8.CreateNoteInput.md) | the note to create | +| `config?` | `Object` | any configurations if needed, including meta data | +| `config.metadata` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | - | + +#### Returns + +`Promise`<[`Note`](internal-8.internal.Note.md)\> + +resolves to the creation result + +#### Defined in + +packages/medusa/dist/services/note.d.ts:53 + +___ + +### delete + +▸ **delete**(`noteId`): `Promise`<`void`\> + +Deletes a given note + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `noteId` | `string` | id of the note to delete | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/note.d.ts:67 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Note`](internal-8.internal.Note.md)[]\> + +Fetches all notes related to the given selector + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Note`](internal-8.internal.Note.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Note`](internal-8.internal.Note.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[`Note`](internal-8.internal.Note.md)[]\> + +notes related to the given search. + +#### Defined in + +packages/medusa/dist/services/note.d.ts:37 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Note`](internal-8.internal.Note.md)[], `number`]\> + +Fetches all notes related to the given selector + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Note`](internal-8.internal.Note.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Note`](internal-8.internal.Note.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[[`Note`](internal-8.internal.Note.md)[], `number`]\> + +notes related to the given search. + +#### Defined in + +packages/medusa/dist/services/note.d.ts:46 + +___ + +### retrieve + +▸ **retrieve**(`noteId`, `config?`): `Promise`<[`Note`](internal-8.internal.Note.md)\> + +Retrieves a specific note. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `noteId` | `string` | the id of the note to retrieve. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Note`](internal-8.internal.Note.md)\> | any options needed to query for the result. | + +#### Returns + +`Promise`<[`Note`](internal-8.internal.Note.md)\> + +which resolves to the requested note. + +#### Defined in + +packages/medusa/dist/services/note.d.ts:28 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`noteId`, `value`): `Promise`<[`Note`](internal-8.internal.Note.md)\> + +Updates a given note with a new value + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `noteId` | `string` | the id of the note to update | +| `value` | `string` | the new value | + +#### Returns + +`Promise`<[`Note`](internal-8.internal.Note.md)\> + +resolves to the updated element + +#### Defined in + +packages/medusa/dist/services/note.d.ts:62 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NoteService`](internal-8.internal.NoteService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`NoteService`](internal-8.internal.NoteService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md new file mode 100644 index 0000000000..b21c9dcc9c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Notification.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Notification + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Notification + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Notification`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:17 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### customer + +• **customer**: [`Customer`](internal-3.Customer.md) + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:9 + +___ + +### customer\_id + +• **customer\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:8 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:11 + +___ + +### event\_name + +• **event\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:5 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### parent\_id + +• **parent\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:12 + +___ + +### parent\_notification + +• **parent\_notification**: [`Notification`](internal-8.internal.Notification.md) + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:13 + +___ + +### provider + +• **provider**: [`NotificationProvider`](internal-8.NotificationProvider.md) + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:16 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:15 + +___ + +### resends + +• **resends**: [`Notification`](internal-8.internal.Notification.md)[] + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:14 + +___ + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:7 + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:6 + +___ + +### to + +• **to**: `string` + +#### Defined in + +packages/medusa/dist/models/notification.d.ts:10 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md new file mode 100644 index 0000000000..fbbb9df5c1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NotificationService.md @@ -0,0 +1,496 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NotificationService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).NotificationService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`NotificationService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### attachmentGenerator\_ + +• `Protected` **attachmentGenerator\_**: `unknown` + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:17 + +___ + +### container\_ + +• `Protected` `Readonly` **container\_**: [`InjectedDependencies`](../modules/internal-8.md#injecteddependencies-16) & {} + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:18 + +___ + +### logger\_ + +• `Protected` `Readonly` **logger\_**: [`Logger`](../modules/internal-8.internal.md#logger) + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### notificationProviderRepository\_ + +• `Protected` `Readonly` **notificationProviderRepository\_**: `Repository`<[`NotificationProvider`](internal-8.NotificationProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:23 + +___ + +### notificationRepository\_ + +• `Protected` `Readonly` **notificationRepository\_**: `Repository`<[`Notification`](internal-8.internal.Notification.md)\> + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:22 + +___ + +### subscribers\_ + +• `Protected` **subscribers\_**: `Object` + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:16 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### handleEvent + +▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| [`Notification`](internal-8.internal.Notification.md)[]\> + +Handles an event by relaying the event data to the subscribing providers. +The result of the notification send will be persisted in the database in +order to allow for resends. Will log any errors that are encountered. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` | the event to handle | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the data the event was sent with | + +#### Returns + +`Promise`<`undefined` \| `void` \| [`Notification`](internal-8.internal.Notification.md)[]\> + +the result of notification subscribed + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:78 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Notification`](internal-8.internal.Notification.md)[]\> + +Retrieves a list of notifications. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Notification`](internal-8.internal.Notification.md)\> | the params to select the notifications by. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Notification`](internal-8.internal.Notification.md)\> | the configuration to apply to the query | + +#### Returns + +`Promise`<[`Notification`](internal-8.internal.Notification.md)[]\> + +the notifications that satisfy the query. + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:42 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Notification`](internal-8.internal.Notification.md)[], `number`]\> + +Retrieves a list of notifications and total count. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Notification`](internal-8.internal.Notification.md)\> | the params to select the notifications by. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Notification`](internal-8.internal.Notification.md)\> | the configuration to apply to the query | + +#### Returns + +`Promise`<[[`Notification`](internal-8.internal.Notification.md)[], `number`]\> + +the notifications that satisfy the query as well as the count. + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:49 + +___ + +### registerAttachmentGenerator + +▸ **registerAttachmentGenerator**(`service`): `void` + +Registers an attachment generator to the service. The generator can be +used to generate on demand invoices or other documents. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `service` | `unknown` | the service to assign to the attachmentGenerator | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:30 + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> + +Takes a list of notification provider ids and persists them in the database. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `providerIds` | `string`[] | a list of provider ids | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:35 + +___ + +### resend + +▸ **resend**(`id`, `config?`): `Promise`<[`Notification`](internal-8.internal.Notification.md)\> + +Resends a notification by retrieving a prior notification and calling the +underlying provider's resendNotification method. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the notification | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Notification`](internal-8.internal.Notification.md)\> | any configuration that might override the previous send | + +#### Returns + +`Promise`<[`Notification`](internal-8.internal.Notification.md)\> + +the newly created notification + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:96 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`Notification`](internal-8.internal.Notification.md)\> + +Retrieves a notification with a given id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the notification | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Notification`](internal-8.internal.Notification.md)\> | the configuration to apply to the query | + +#### Returns + +`Promise`<[`Notification`](internal-8.internal.Notification.md)\> + +the notification + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:56 + +___ + +### retrieveProvider\_ + +▸ `Protected` **retrieveProvider_**(`id`): [`AbstractNotificationService`](internal-8.internal.AbstractNotificationService.md) + +Finds a provider with a given id. Will throw a NOT_FOUND error if the +resolution fails. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the provider | + +#### Returns + +[`AbstractNotificationService`](internal-8.internal.AbstractNotificationService.md) + +the notification provider + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:69 + +___ + +### send + +▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| [`Notification`](internal-8.internal.Notification.md)\> + +Sends a notification, by calling the given provider's sendNotification +method. Persists the Notification in the database. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `event` | `string` | the name of the event | +| `eventData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the data the event was sent with | +| `providerId` | `string` | the provider that should handle the event. | + +#### Returns + +`Promise`<`undefined` \| [`Notification`](internal-8.internal.Notification.md)\> + +the created notification + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:87 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `providerId`): `void` + +Subscribes a given provider to an event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` | the event to subscribe to | +| `providerId` | `string` | the provider that the event will be sent to | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:62 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`NotificationService`](internal-8.internal.NotificationService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`NotificationService`](internal-8.internal.NotificationService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md new file mode 100644 index 0000000000..b6372cd46c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.NumericalComparisonOperator.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: NumericalComparisonOperator + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).NumericalComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:99 + +___ + +### gte + +• `Optional` **gte**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:100 + +___ + +### lt + +• `Optional` **lt**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:98 + +___ + +### lte + +• `Optional` **lte**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md new file mode 100644 index 0000000000..eed0157779 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Oauth.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Oauth + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Oauth + +## Properties + +### application\_name + +• **application\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:4 + +___ + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:8 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:7 + +___ + +### display\_name + +• **display\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:2 + +___ + +### install\_url + +• **install\_url**: `string` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:5 + +___ + +### uninstall\_url + +• **uninstall\_url**: `string` + +#### Defined in + +packages/medusa/dist/models/oauth.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md new file mode 100644 index 0000000000..7738fc1e14 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OauthService.md @@ -0,0 +1,398 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OauthService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).OauthService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`OauthService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### container\_ + +• `Protected` **container\_**: [`InjectedDependencies`](../modules/internal-8.md#injecteddependencies-17) + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:19 + +___ + +### eventBus\_ + +• `Protected` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### oauthRepository\_ + +• `Protected` **oauthRepository\_**: `Repository`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:20 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `TOKEN_GENERATED` | `string` | +| `TOKEN_REFRESHED` | `string` | + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:15 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateOauthInput`](../modules/internal-8.md#createoauthinput) | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:26 + +___ + +### generateToken + +▸ **generateToken**(`appName`, `code`, `state`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appName` | `string` | +| `code` | `string` | +| `state` | `string` | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:29 + +___ + +### list + +▸ **list**(`selector`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Oauth`](internal-8.internal.Oauth.md)\> | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)[]\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:25 + +___ + +### refreshToken + +▸ **refreshToken**(`appName`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appName` | `string` | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:30 + +___ + +### registerOauthApp + +▸ **registerOauthApp**(`appDetails`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appDetails` | [`CreateOauthInput`](../modules/internal-8.md#createoauthinput) | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:28 + +___ + +### retrieve + +▸ **retrieve**(`oauthId`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `oauthId` | `string` | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:24 + +___ + +### retrieveByName + +▸ **retrieveByName**(`appName`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `appName` | `string` | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:23 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `update`): `Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `update` | [`UpdateOauthInput`](../modules/internal-8.md#updateoauthinput) | + +#### Returns + +`Promise`<[`Oauth`](internal-8.internal.Oauth.md)\> + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:27 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OauthService`](internal-8.internal.OauthService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`OauthService`](internal-8.internal.OauthService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md new file mode 100644 index 0000000000..41f47db423 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditItemChangeService.md @@ -0,0 +1,327 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderEditItemChangeService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).OrderEditItemChangeService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`OrderEditItemChangeService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:23 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:24 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### orderItemChangeRepository\_ + +• `Protected` `Readonly` **orderItemChangeRepository\_**: `Repository`<[`OrderItemChange`](internal-3.OrderItemChange.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:22 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:25 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:18 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateOrderEditItemChangeInput`](../modules/internal-8.md#createorderedititemchangeinput) | + +#### Returns + +`Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:29 + +___ + +### delete + +▸ **delete**(`itemChangeIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemChangeIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:30 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`OrderItemChange`](internal-3.OrderItemChange.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderItemChange`](internal-3.OrderItemChange.md)\> | + +#### Returns + +`Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)[]\> + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:28 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderItemChange`](internal-3.OrderItemChange.md)\> | + +#### Returns + +`Promise`<[`OrderItemChange`](internal-3.OrderItemChange.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:27 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](internal-8.internal.OrderEditItemChangeService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`OrderEditItemChangeService`](internal-8.internal.OrderEditItemChangeService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md new file mode 100644 index 0000000000..bd2c9795bb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderEditService.md @@ -0,0 +1,707 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderEditService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).OrderEditService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`OrderEditService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:37 + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: `undefined` \| [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:41 + +___ + +### lineItemAdjustmentService\_ + +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:39 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:36 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### newTotalsService\_ + +• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:35 + +___ + +### orderEditItemChangeService\_ + +• `Protected` `Readonly` **orderEditItemChangeService\_**: [`OrderEditItemChangeService`](internal-8.internal.OrderEditItemChangeService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:40 + +___ + +### orderEditRepository\_ + +• `Protected` `Readonly` **orderEditRepository\_**: `Repository`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:32 + +___ + +### orderService\_ + +• `Protected` `Readonly` **orderService\_**: [`OrderService`](internal-8.internal.OrderService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:33 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:38 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:34 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `CONFIRMED` | `string` | +| `CREATED` | `string` | +| `DECLINED` | `string` | +| `REQUESTED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:24 + +___ + +### isOrderEditActive + +▪ `Static` `Private` **isOrderEditActive**: `any` + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:86 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addLineItem + +▸ **addLineItem**(`orderEditId`, `data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `data` | [`AddOrderEditLineItemInput`](../modules/internal-8.md#addordereditlineiteminput) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:73 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context?` | `Object` | +| `context.canceledBy?` | `string` | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:78 + +___ + +### confirm + +▸ **confirm**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context?` | `Object` | +| `context.confirmedBy?` | `string` | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:81 + +___ + +### create + +▸ **create**(`data`, `context`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateOrderEditInput`](../modules/internal-8.md#createordereditinput) | +| `context` | `Object` | +| `context.createdBy` | `string` | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:48 + +___ + +### decline + +▸ **decline**(`orderEditId`, `context`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context` | `Object` | +| `context.declinedBy?` | `string` | +| `context.declinedReason?` | `string` | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:53 + +___ + +### decorateTotals + +▸ **decorateTotals**(`orderEdit`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEdit` | [`OrderEdit`](internal-3.OrderEdit.md) | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:72 + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:52 + +___ + +### deleteClonedItems + +▸ `Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:85 + +___ + +### deleteItemChange + +▸ **deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemChangeId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:74 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`OrderEdit`](internal-3.OrderEdit.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderEdit`](internal-3.OrderEdit.md)\> | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)[]\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:47 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`OrderEdit`](internal-3.OrderEdit.md)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`OrderEdit`](internal-3.OrderEdit.md)\> & { `q?`: `string` } | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderEdit`](internal-3.OrderEdit.md)\> | + +#### Returns + +`Promise`<[[`OrderEdit`](internal-3.OrderEdit.md)[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:44 + +___ + +### refreshAdjustments + +▸ **refreshAdjustments**(`orderEditId`, `config?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `config?` | `Object` | +| `config.preserveCustomAdjustments` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:69 + +___ + +### removeLineItem + +▸ **removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `lineItemId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:68 + +___ + +### requestConfirmation + +▸ **requestConfirmation**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `context?` | `Object` | +| `context.requestedBy?` | `string` | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:75 + +___ + +### retrieve + +▸ **retrieve**(`orderEditId`, `config?`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderEdit`](internal-3.OrderEdit.md)\> | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:43 + +___ + +### retrieveActive + +▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| [`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderId` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`OrderEdit`](internal-3.OrderEdit.md)\> | + +#### Returns + +`Promise`<`undefined` \| ``null`` \| [`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:84 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`orderEditId`, `data`): `Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `data` | `DeepPartial`<[`OrderEdit`](internal-3.OrderEdit.md)\> | + +#### Returns + +`Promise`<[`OrderEdit`](internal-3.OrderEdit.md)\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:51 + +___ + +### updateLineItem + +▸ **updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\> + +Create or update order edit item change line item and apply the quantity +- If the item change already exists then update the quantity of the line item as well as the line adjustments +- If the item change does not exist then create the item change of type update and apply the quantity as well as update the line adjustments + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderEditId` | `string` | +| `itemId` | `string` | +| `data` | `Object` | +| `data.quantity` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:65 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderEditService`](internal-8.internal.OrderEditService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`OrderEditService`](internal-8.internal.OrderEditService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md new file mode 100644 index 0000000000..87f0e53c73 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.OrderService.md @@ -0,0 +1,1155 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: OrderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).OrderService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`OrderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### addressRepository\_ + +• `Protected` `Readonly` **addressRepository\_**: `Repository`<[`Address`](internal-3.Address.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:72 + +___ + +### cartService\_ + +• `Protected` `Readonly` **cartService\_**: [`CartService`](internal-8.internal.CartService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:71 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:59 + +___ + +### discountService\_ + +• `Protected` `Readonly` **discountService\_**: [`DiscountService`](internal-8.internal.DiscountService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:63 + +___ + +### draftOrderService\_ + +• `Protected` `Readonly` **draftOrderService\_**: [`DraftOrderService`](internal-8.internal.DraftOrderService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:74 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:76 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:77 + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:64 + +___ + +### fulfillmentService\_ + +• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](internal-8.FulfillmentService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:65 + +___ + +### getTotalsRelations + +• `Private` **getTotalsRelations**: `any` + +#### Defined in + +packages/medusa/dist/services/order.d.ts:266 + +___ + +### giftCardService\_ + +• `Protected` `Readonly` **giftCardService\_**: [`GiftCardService`](internal-8.internal.GiftCardService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:73 + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:75 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:66 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### newTotalsService\_ + +• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:68 + +___ + +### orderRepository\_ + +• `Protected` `Readonly` **orderRepository\_**: `Repository`<[`Order`](internal-3.Order.md)\> & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Order`](internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](internal-3.Order.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Order`](internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](internal-3.Order.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/order.d.ts:58 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:60 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:78 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:70 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:61 + +___ + +### shippingProfileService\_ + +• `Protected` `Readonly` **shippingProfileService\_**: [`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:62 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:69 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/order.d.ts:67 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CANCELED` | `string` | +| `COMPLETED` | `string` | +| `FULFILLMENT_CANCELED` | `string` | +| `FULFILLMENT_CREATED` | `string` | +| `GIFT_CARD_CREATED` | `string` | +| `ITEMS_RETURNED` | `string` | +| `PAYMENT_CAPTURED` | `string` | +| `PAYMENT_CAPTURE_FAILED` | `string` | +| `PLACED` | `string` | +| `REFUND_CREATED` | `string` | +| `REFUND_FAILED` | `string` | +| `RETURN_ACTION_REQUIRED` | `string` | +| `RETURN_REQUESTED` | `string` | +| `SHIPMENT_CREATED` | `string` | +| `SWAP_CREATED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/order.d.ts:40 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addShippingMethod + +▸ **addShippingMethod**(`orderId`, `optionId`, `data?`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderId` | `string` | +| `optionId` | `string` | +| `data?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `config?` | [`CreateShippingMethodDto`](../modules/internal-8.md#createshippingmethoddto) | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:161 + +___ + +### archive + +▸ **archive**(`orderId`): `Promise`<[`Order`](internal-3.Order.md)\> + +Archives an order. It only alloved, if the order has been fulfilled +and payment has been captured. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the order to archive | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:236 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`orderId`): `Promise`<[`Order`](internal-3.Order.md)\> + +Cancels an order. +Throws if fulfillment process has been initiated. +Throws if payment process has been initiated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to cancel. | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +result of the update operation. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:179 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Order`](internal-3.Order.md)\> + +Cancels a fulfillment (if related to an order) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentId` | `string` | the ID of the fulfillment to cancel | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +updated order + +#### Defined in + +packages/medusa/dist/services/order.d.ts:218 + +___ + +### capturePayment + +▸ **capturePayment**(`orderId`): `Promise`<[`Order`](internal-3.Order.md)\> + +Captures payment for an order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to capture payment for. | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +result of the update operation. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:185 + +___ + +### completeOrder + +▸ **completeOrder**(`orderId`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of the order to complete | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:125 + +___ + +### createFromCart + +▸ **createFromCart**(`cartOrId`): `Promise`<[`Order`](internal-3.Order.md)\> + +Creates an order from a cart + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartOrId` | `string` \| [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +resolves to the creation result. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:131 + +___ + +### createFulfillment + +▸ **createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Creates fulfillments for an order. +In a situation where the order has more than one shipping method, +we need to partition the order items, such that they can be sent +to their respective fulfillment provider. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of order to fulfil. | +| `itemsToFulfill` | [`FulFillmentItemType`](../modules/internal-8.md#fulfillmentitemtype)[] | items to fulfil. | +| `config?` | `Object` | the config to fulfil. | +| `config.location_id?` | `string` | - | +| `config.metadata?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | - | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +result of the update operation. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:208 + +___ + +### createGiftCardsFromLineItem\_ + +▸ `Protected` **createGiftCardsFromLineItem_**(`order`, `lineItem`, `manager`): `Promise`<[`GiftCard`](internal-3.GiftCard.md)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | +| `manager` | `EntityManager` | + +#### Returns + +`Promise`<[`GiftCard`](internal-3.GiftCard.md)\>[] + +#### Defined in + +packages/medusa/dist/services/order.d.ts:132 + +___ + +### createRefund + +▸ **createRefund**(`orderId`, `refundAmount`, `reason`, `note?`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Refunds a given amount back to the customer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id of the order to refund. | +| `refundAmount` | `number` | the amount to refund. | +| `reason` | `string` | the reason to refund. | +| `note?` | `string` | note for refund. | +| `config?` | `Object` | the config for refund. | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the result of the refund operation. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:246 + +___ + +### createShipment + +▸ **createShipment**(`orderId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Adds a shipment to the order to indicate that an order has left the +warehouse. Will ask the fulfillment provider for any documents that may +have been created in regards to the shipment. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the id of the order that has been shipped | +| `fulfillmentId` | `string` | the fulfillment that has now been shipped | +| `trackingLinks?` | [`TrackingLink`](internal-3.TrackingLink.md)[] | array of tracking numbers associated with the shipment | +| `config?` | `Object` | the config of the order that has been shipped | +| `config.metadata` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | - | +| `config.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the resulting order following the update. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:143 + +___ + +### decorateTotals + +▸ **decorateTotals**(`order`, `totalsFields?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | +| `totalsFields?` | `string`[] | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:250 + +▸ **decorateTotals**(`order`, `context?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | +| `context?` | [`TotalsContext`](../modules/internal-8.md#totalscontext) | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:251 + +___ + +### decorateTotalsLegacy + +▸ `Protected` **decorateTotalsLegacy**(`order`, `totalsFields?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | +| `totalsFields?` | `string`[] | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:249 + +___ + +### getFulfillmentItems + +▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +Retrieves the order line items, given an array of items. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to get line items from | +| `items` | [`FulFillmentItemType`](../modules/internal-8.md#fulfillmentitemtype)[] | the items to get | +| `transformer` | (`item`: `undefined` \| [`LineItem`](internal-3.LineItem.md), `quantity`: `number`) => `unknown` | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md)[]\> + +the line items generated by the transformer. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:229 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Order`](internal-3.Order.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Order`](internal-3.Order.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:85 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Order`](internal-3.Order.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`Order`](internal-3.Order.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[[`Order`](internal-3.Order.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:91 + +___ + +### registerReturnReceived + +▸ **registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Handles receiving a return. This will create a +refund to the customer. If the returned items don't match the requested +items the return status will be updated to requires_action. This behaviour +is useful in situations where a custom refund amount is requested, but the +returned items are not matching the requested items. Setting the +allowMismatch argument to true, will process the return, ignoring any +mismatches. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the order to return. | +| `receivedReturn` | [`Return`](internal-3.Return.md) | the received return | +| `customRefundAmount?` | `number` | the custom refund amount return | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:265 + +___ + +### retrieve + +▸ **retrieve**(`orderId`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Gets an order by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | id or selector of order to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | config of order to retrieve | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the order document + +#### Defined in + +packages/medusa/dist/services/order.d.ts:103 + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Gets an order by cart id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | cart id to find order | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | the config to be used to find order | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the order document + +#### Defined in + +packages/medusa/dist/services/order.d.ts:112 + +___ + +### retrieveByCartIdWithTotals + +▸ **retrieveByCartIdWithTotals**(`cartId`, `options?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:113 + +___ + +### retrieveByExternalId + +▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +Gets an order by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `externalId` | `string` | id of order to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | query config to get order by | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +the order document + +#### Defined in + +packages/medusa/dist/services/order.d.ts:120 + +___ + +### retrieveLegacy + +▸ `Protected` **retrieveLegacy**(`orderIdOrSelector`, `config?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderIdOrSelector` | `string` \| [`Selector`](../modules/internal-8.internal.md#selector)<[`Order`](internal-3.Order.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:104 + +___ + +### retrieveWithTotals + +▸ **retrieveWithTotals**(`orderId`, `options?`, `context?`): `Promise`<[`Order`](internal-3.Order.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `orderId` | `string` | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | +| `context?` | [`TotalsContext`](../modules/internal-8.md#totalscontext) | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +#### Defined in + +packages/medusa/dist/services/order.d.ts:105 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### transformQueryForTotals + +▸ `Protected` **transformQueryForTotals**(`config`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Order`](internal-3.Order.md)\> | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `relations` | `undefined` \| `string`[] | +| `select` | `undefined` \| keyof [`Order`](internal-3.Order.md)[] | +| `totalsToSelect` | `undefined` \| keyof [`Order`](internal-3.Order.md)[] | + +#### Defined in + +packages/medusa/dist/services/order.d.ts:92 + +___ + +### update + +▸ **update**(`orderId`, `update`): `Promise`<[`Order`](internal-3.Order.md)\> + +Updates an order. Metadata updates should +use dedicated method, e.g. `setMetadata` etc. The function +will throw errors if metadata updates are attempted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderId` | `string` | the id of the order. Must be a string that can be casted to an ObjectId | +| `update` | [`UpdateOrderInput`](../modules/internal-8.md#updateorderinput) | an object with the update values. | + +#### Returns + +`Promise`<[`Order`](internal-3.Order.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:171 + +___ + +### updateBillingAddress + +▸ `Protected` **updateBillingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's billing address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to update | +| `address` | [`Address`](internal-3.Address.md) | the value to set the billing address to | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:153 + +___ + +### updateShippingAddress + +▸ `Protected` **updateShippingAddress**(`order`, `address`): `Promise`<`void`\> + +Updates the order's shipping address. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to update | +| `address` | [`Address`](internal-3.Address.md) | the value to set the shipping address to | + +#### Returns + +`Promise`<`void`\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/order.d.ts:160 + +___ + +### validateFulfillmentLineItem + +▸ `Protected` **validateFulfillmentLineItem**(`item`, `quantity`): ``null`` \| [`LineItem`](internal-3.LineItem.md) + +Checks that a given quantity of a line item can be fulfilled. Fails if the +fulfillable quantity is lower than the requested fulfillment quantity. +Fulfillable quantity is calculated by subtracting the already fulfilled +quantity from the quantity that was originally purchased. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `item` | [`LineItem`](internal-3.LineItem.md) | the line item to check has sufficient fulfillable quantity. | +| `quantity` | `number` | the quantity that is requested to be fulfilled. | + +#### Returns + +``null`` \| [`LineItem`](internal-3.LineItem.md) + +a line item that has the requested fulfillment quantity + set. + +#### Defined in + +packages/medusa/dist/services/order.d.ts:197 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`OrderService`](internal-8.internal.OrderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`OrderService`](internal-8.internal.OrderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md new file mode 100644 index 0000000000..ba72d4e175 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentCollectionService.md @@ -0,0 +1,483 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentCollectionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentCollectionService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`PaymentCollectionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:25 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:23 + +___ + +### isValidTotalAmount + +• `Private` **isValidTotalAmount**: `any` + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:54 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### paymentCollectionRepository\_ + +• `Protected` `Readonly` **paymentCollectionRepository\_**: `Repository`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> & { `getPaymentCollectionIdByPaymentId`: (`paymentId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> ; `getPaymentCollectionIdBySessionId`: (`sessionId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> } + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:26 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:24 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `PAYMENT_AUTHORIZED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:17 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePaymentSessions + +▸ **authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Authorizes the payment sessions of a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection | +| `sessionIds` | `string`[] | array of payment session ids to be authorized | +| `context?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | additional data required by payment providers | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection and its payment session. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:92 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Creates a new payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreatePaymentCollectionInput`](../modules/internal-8.md#createpaymentcollectioninput) | info to create the payment collection | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection created. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:40 + +___ + +### delete + +▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| [`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Deletes a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection to be removed | + +#### Returns + +`Promise`<`undefined` \| [`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection removed. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:53 + +___ + +### markAsAuthorized + +▸ **markAsAuthorized**(`paymentCollectionId`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Marks a payment collection as authorized bypassing the payment flow. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment session authorized. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:84 + +___ + +### refreshPaymentSession + +▸ **refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Removes and recreate a payment session of a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection | +| `sessionId` | `string` | the id of the payment session to be replaced | +| `customerId` | `string` | the id of the customer | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +the new payment session created. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:78 + +___ + +### retrieve + +▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Retrieves a payment collection by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`PaymentCollection`](internal-3.PaymentCollection.md)\> | the config to retrieve the payment collection | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:34 + +___ + +### setPaymentSession + +▸ **setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Manages a single payment sessions of a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection | +| `sessionInput` | [`PaymentCollectionsSessionsInput`](../modules/internal-8.md#paymentcollectionssessionsinput) | object containing payment session info | +| `customerId` | `string` | the id of the customer | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection and its payment session. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:70 + +___ + +### setPaymentSessionsBatch + +▸ **setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Manages multiple payment sessions of a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionOrId` | `string` \| [`PaymentCollection`](internal-3.PaymentCollection.md) | the id of the payment collection | +| `sessionsInput` | [`PaymentCollectionsSessionsBatchInput`](../modules/internal-8.md#paymentcollectionssessionsbatchinput)[] | array containing payment session info | +| `customerId` | `string` | the id of the customer | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection and its payment sessions. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:62 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`paymentCollectionId`, `data`): `Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +Updates a payment collection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentCollectionId` | `string` | the id of the payment collection to update | +| `data` | `DeepPartial`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> | info to be updated | + +#### Returns + +`Promise`<[`PaymentCollection`](internal-3.PaymentCollection.md)\> + +the payment collection updated. + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:47 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentCollectionService`](internal-8.internal.PaymentCollectionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PaymentCollectionService`](internal-8.internal.PaymentCollectionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md new file mode 100644 index 0000000000..5bd7737819 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PaymentProviderService.md @@ -0,0 +1,832 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PaymentProviderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentProviderService + +Helps retrieve payment providers + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`PaymentProviderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### container\_ + +• `Protected` `Readonly` **container\_**: [`InjectedDependencies`](../modules/internal-8.md#injecteddependencies-22) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:33 + +___ + +### customerService\_ + +• `Protected` `Readonly` **customerService\_**: [`CustomerService`](internal-8.internal.CustomerService.md) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:39 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:41 + +___ + +### logger\_ + +• `Protected` `Readonly` **logger\_**: [`Logger`](../modules/internal-8.internal.md#logger) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:40 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### paymentProviderRepository\_ + +• `Protected` `Readonly` **paymentProviderRepository\_**: `Repository`<[`PaymentProvider`](internal-3.PaymentProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:35 + +___ + +### paymentRepository\_ + +• `Protected` `Readonly` **paymentRepository\_**: `Repository`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:36 + +___ + +### paymentSessionRepository\_ + +• `Protected` `Readonly` **paymentSessionRepository\_**: `Repository`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:34 + +___ + +### refundRepository\_ + +• `Protected` `Readonly` **refundRepository\_**: `Repository`<[`Refund`](internal-3.Refund.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:38 + +___ + +### throwFromPaymentProcessorError + +• `Private` **throwFromPaymentProcessorError**: `any` + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:154 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +___ + +### paymentService\_ + +• `Protected` `get` **paymentService_**(): [`PaymentService`](internal-8.PaymentService.md) + +#### Returns + +[`PaymentService`](internal-8.PaymentService.md) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:37 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePayment + +▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<`undefined` \| [`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | +| `context` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`undefined` \| [`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:110 + +___ + +### buildPaymentProcessorContext + +▸ `Protected` **buildPaymentProcessorContext**(`cartOrData`): [`Cart`](internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) + +Build the create session context for both legacy and new API + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartOrData` | [`Cart`](internal-3.Cart.md) \| [`PaymentSessionInput`](../modules/internal-8.md#paymentsessioninput) | + +#### Returns + +[`Cart`](internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:127 + +___ + +### cancelPayment + +▸ **cancelPayment**(`paymentObj`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentObj` | [`Partial`](../modules/internal-8.md#partial)<[`Payment`](internal-3.Payment.md)\> & { `id`: `string` } | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:112 + +___ + +### capturePayment + +▸ **capturePayment**(`paymentObj`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentObj` | [`Partial`](../modules/internal-8.md#partial)<[`Payment`](internal-3.Payment.md)\> & { `id`: `string` } | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:116 + +___ + +### createPayment + +▸ **createPayment**(`data`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreatePaymentInput`](../modules/internal-8.md#createpaymentinput) | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:105 + +___ + +### createSession + +▸ **createSession**(`providerId`, `cart`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providerId` | `string` | +| `cart` | [`Cart`](internal-3.Cart.md) | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +**`Deprecated`** + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:68 + +▸ **createSession**(`sessionInput`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Creates a payment session with the given provider. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `sessionInput` | [`PaymentSessionInput`](../modules/internal-8.md#paymentsessioninput) | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:73 + +___ + +### deleteSession + +▸ **deleteSession**(`paymentSession`): `Promise`<`undefined` \| [`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | + +#### Returns + +`Promise`<`undefined` \| [`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:98 + +___ + +### getStatus + +▸ **getStatus**(`payment`): `Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](internal-3.Payment.md) | + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:115 + +___ + +### list + +▸ **list**(): `Promise`<[`PaymentProvider`](internal-3.PaymentProvider.md)[]\> + +#### Returns + +`Promise`<[`PaymentProvider`](internal-3.PaymentProvider.md)[]\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:44 + +___ + +### listPayments + +▸ **listPayments**(`selector`, `config?`): `Promise`<[`Payment`](internal-3.Payment.md)[]\> + +List all the payments according to the given selector and config. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Payment`](internal-3.Payment.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Payment`](internal-3.Payment.md)\> | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)[]\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:56 + +___ + +### processUpdateRequestsData + +▸ `Protected` **processUpdateRequestsData**(`data`, `paymentResponse`): `Promise`<`void`\> + +Process the collected data. Can be used every time we need to process some collected data returned by the provider + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `undefined` \| { `customer?`: { `id?`: `string` } } | +| `paymentResponse` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:149 + +___ + +### refreshSession + +▸ **refreshSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Refreshes a payment session with the given provider. +This means, that we delete the current one and create a new. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentSession` | `Object` | the payment session object to update | +| `paymentSession.data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | - | +| `paymentSession.id` | `string` | - | +| `paymentSession.provider_id` | `string` | - | +| `sessionInput` | [`PaymentSessionInput`](../modules/internal-8.md#paymentsessioninput) | | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +the payment session + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:82 + +___ + +### refundFromPayment + +▸ **refundFromPayment**(`payment`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](internal-3.Payment.md) | +| `amount` | `number` | +| `reason` | `string` | +| `note?` | `string` | + +#### Returns + +`Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:120 + +___ + +### refundPayment + +▸ **refundPayment**(`payObjs`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payObjs` | [`Payment`](internal-3.Payment.md)[] | +| `amount` | `number` | +| `reason` | `string` | +| `note?` | `string` | + +#### Returns + +`Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:119 + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providerIds` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:43 + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentId`, `relations?`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +Retrieve a payment entity with the given id. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentId` | `string` | +| `relations?` | `string`[] | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:50 + +___ + +### retrieveProvider + +▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) ? [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) : `TProvider` extends [`AbstractPaymentProcessor`](internal-8.internal.AbstractPaymentProcessor.md) ? [`AbstractPaymentProcessor`](internal-8.internal.AbstractPaymentProcessor.md) : `any` + +Finds a provider given an id + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TProvider` | extends `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `providerId` | `string` | the id of the provider to get | + +#### Returns + +`TProvider` extends [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) ? [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) : `TProvider` extends [`AbstractPaymentProcessor`](internal-8.internal.AbstractPaymentProcessor.md) ? [`AbstractPaymentProcessor`](internal-8.internal.AbstractPaymentProcessor.md) : `any` + +the payment provider + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:104 + +___ + +### retrieveRefund + +▸ **retrieveRefund**(`id`, `config?`): `Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Refund`](internal-3.Refund.md)\> | + +#### Returns + +`Promise`<[`Refund`](internal-3.Refund.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:121 + +___ + +### retrieveSession + +▸ **retrieveSession**(`paymentSessionId`, `relations?`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Return the payment session for the given id. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionId` | `string` | +| `relations?` | `string`[] | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:62 + +___ + +### saveSession + +▸ `Protected` **saveSession**(`providerId`, `data`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Create or update a Payment session data. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providerId` | `string` | +| `data` | `Object` | +| `data.amount?` | `number` | +| `data.cartId?` | `string` | +| `data.isInitiated?` | `boolean` | +| `data.isSelected?` | `boolean` | +| `data.payment_session_id?` | `string` | +| `data.sessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `data.status?` | [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:134 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### updatePayment + +▸ **updatePayment**(`paymentId`, `data`): `Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentId` | `string` | +| `data` | `Object` | +| `data.order_id?` | `string` | +| `data.swap_id?` | `string` | + +#### Returns + +`Promise`<[`Payment`](internal-3.Payment.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:106 + +___ + +### updateSession + +▸ **updateSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +Update a payment session with the given provider. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `paymentSession` | `Object` | The paymentSession to update | +| `paymentSession.data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | - | +| `paymentSession.id` | `string` | - | +| `paymentSession.provider_id` | `string` | - | +| `sessionInput` | [`Cart`](internal-3.Cart.md) \| [`PaymentSessionInput`](../modules/internal-8.md#paymentsessioninput) | | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +the payment session + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:93 + +___ + +### updateSessionData + +▸ **updateSessionData**(`paymentSession`, `data`): `Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](internal-3.PaymentSession.md) | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`PaymentSession`](internal-3.PaymentSession.md)\> + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:111 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md new file mode 100644 index 0000000000..a2ecbd2cea --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PriceListService.md @@ -0,0 +1,653 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PriceListService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PriceListService + +Provides layer to manipulate product tags. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`PriceListService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customerGroupService\_ + +• `Protected` `Readonly` **customerGroupService\_**: [`CustomerGroupService`](internal-8.internal.CustomerGroupService.md) + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:31 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:38 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### moneyAmountRepo\_ + +• `Protected` `Readonly` **moneyAmountRepo\_**: `Repository`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: [`PriceListPriceCreateInput`](../modules/internal-8.internal.md#pricelistpricecreateinput)[], `overrideExisting?`: `boolean`) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: [`ProductVariantPrice`](../modules/internal-8.md#productvariantprice)[] ; `variantId`: `string` }[], `prices?`: [`Price`](../modules/internal-8.md#price)[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`Currency`](internal-3.Currency.md) ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| [`PriceList`](internal-3.PriceList.md) ; `price_list_id`: ``null`` \| `string` ; `region?`: [`Region`](internal-3.Region.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](internal-3.ProductVariant.md)[] }[]\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList?`: `boolean`) => `Promise`<[[`MoneyAmount`](internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`MoneyAmount`](internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`Record`](../modules/internal.md#record)<`string`, [`MoneyAmount`](internal-3.MoneyAmount.md)[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`Currency`](internal-3.Currency.md) ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| [`PriceList`](internal-3.PriceList.md) ; `price_list_id`: ``null`` \| `string` ; `region?`: [`Region`](internal-3.Region.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](internal-3.ProductVariant.md)[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: [`Price`](../modules/internal-8.md#price)[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`MoneyAmount`](internal-3.MoneyAmount.md)\>[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: [`PriceListPriceUpdateInput`](../modules/internal-8.internal.md#pricelistpriceupdateinput)[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: [`Price`](../modules/internal-8.md#price)) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> } + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:36 + +___ + +### priceListRepo\_ + +• `Protected` `Readonly` **priceListRepo\_**: `Repository`<[`PriceList`](internal-3.PriceList.md)\> & { `listAndCount`: (`query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`PriceList`](internal-3.PriceList.md)\>, `q?`: `string`) => `Promise`<[[`PriceList`](internal-3.PriceList.md)[], `number`]\> ; `listPriceListsVariantIdsMap`: (`priceListIds`: `string` \| `string`[]) => `Promise`<{ `[priceListId: string]`: `string`[]; }\> } + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:35 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:33 + +___ + +### productVariantRepo\_ + +• `Protected` `Readonly` **productVariantRepo\_**: `Repository`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:37 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:32 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### variantService\_ + +• `Protected` `Readonly` **variantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:34 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addCurrencyFromRegion + +▸ `Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\> + +Add `currency_code` to an MA record if `region_id`is passed. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`PriceListPriceCreateInput`](../modules/internal-8.internal.md#pricelistpricecreateinput) \| [`PriceListPriceUpdateInput`](../modules/internal-8.internal.md#pricelistpriceupdateinput) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `prices` | `T`[] | a list of PriceListPrice(Create/Update)Input records | + +#### Returns + +`Promise`<`T`[]\> + +updated `prices` list + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:117 + +___ + +### addPrices + +▸ **addPrices**(`id`, `prices`, `replace?`): `Promise`<[`PriceList`](internal-3.PriceList.md)\> + +Adds prices to a price list in bulk, optionally replacing all existing prices + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | +| `prices` | [`PriceListPriceCreateInput`](../modules/internal-8.internal.md#pricelistpricecreateinput)[] | prices to add | +| `replace?` | `boolean` | whether to replace existing prices | + +#### Returns + +`Promise`<[`PriceList`](internal-3.PriceList.md)\> + +updated Price List + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:70 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### clearPrices + +▸ **clearPrices**(`id`): `Promise`<`void`\> + +Removes all prices from a price list and deletes the removed prices in bulk + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | + +#### Returns + +`Promise`<`void`\> + +updated Price List + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:83 + +___ + +### create + +▸ **create**(`priceListObject`): `Promise`<[`PriceList`](internal-3.PriceList.md)\> + +Creates a Price List + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `priceListObject` | [`CreatePriceListInput`](../modules/internal-8.internal.md#createpricelistinput) | the Price List to create | + +#### Returns + +`Promise`<[`PriceList`](internal-3.PriceList.md)\> + +created Price List + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:55 + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +Deletes a Price List +Will never fail due to delete being idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:90 + +___ + +### deletePrices + +▸ **deletePrices**(`id`, `priceIds`): `Promise`<`void`\> + +Removes prices from a price list and deletes the removed prices in bulk + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the price list | +| `priceIds` | `string`[] | ids of the prices to delete | + +#### Returns + +`Promise`<`void`\> + +updated Price List + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:77 + +___ + +### deleteProductPrices + +▸ **deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `productIds` | `string`[] | + +#### Returns + +`Promise`<[`string`[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:110 + +___ + +### deleteVariantPrices + +▸ **deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `variantIds` | `string`[] | + +#### Returns + +`Promise`<[`string`[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:111 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`PriceList`](internal-3.PriceList.md)[]\> + +Lists Price Lists + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`FilterablePriceListProps`](internal-8.internal.FilterablePriceListProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`PriceList`](internal-3.PriceList.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[`PriceList`](internal-3.PriceList.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:97 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`PriceList`](internal-3.PriceList.md)[], `number`]\> + +Lists Price Lists and adds count + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`FilterablePriceListProps`](internal-8.internal.FilterablePriceListProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`PriceList`](internal-3.PriceList.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[[`PriceList`](internal-3.PriceList.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:104 + +___ + +### listPriceListsVariantIdsMap + +▸ **listPriceListsVariantIdsMap**(`priceListIds`): `Promise`<{ `[priceListId: string]`: `string`[]; }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<{ `[priceListId: string]`: `string`[]; }\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:47 + +___ + +### listProducts + +▸ **listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `selector?` | [`FilterableProductProps`](internal-8.FilterableProductProps.md) \| [`Selector`](../modules/internal-8.internal.md#selector)<[`Product`](internal-3.Product.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Product`](internal-3.Product.md)\> | +| `requiresPriceList?` | `boolean` | + +#### Returns + +`Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:108 + +___ + +### listVariants + +▸ **listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`ProductVariant`](internal-3.ProductVariant.md)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `selector?` | [`FilterableProductVariantProps`](internal-8.FilterableProductVariantProps.md) | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductVariant`](internal-3.ProductVariant.md)\> | +| `requiresPriceList?` | `boolean` | + +#### Returns + +`Promise`<[[`ProductVariant`](internal-3.ProductVariant.md)[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:109 + +___ + +### retrieve + +▸ **retrieve**(`priceListId`, `config?`): `Promise`<[`PriceList`](internal-3.PriceList.md)\> + +Retrieves a product tag by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `priceListId` | `string` | the id of the product tag to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`PriceList`](internal-3.PriceList.md)\> | the config to retrieve the tag by | + +#### Returns + +`Promise`<[`PriceList`](internal-3.PriceList.md)\> + +the collection. + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:46 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `update`): `Promise`<[`PriceList`](internal-3.PriceList.md)\> + +Updates a Price List + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the Product List to update | +| `update` | [`UpdatePriceListInput`](../modules/internal-8.internal.md#updatepricelistinput) | the update to apply | + +#### Returns + +`Promise`<[`PriceList`](internal-3.PriceList.md)\> + +updated Price List + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:62 + +___ + +### upsertCustomerGroups\_ + +▸ `Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `priceListId` | `string` | +| `customerGroups` | { `id`: `string` }[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:105 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PriceListService`](internal-8.internal.PriceListService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PriceListService`](internal-8.internal.PriceListService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md new file mode 100644 index 0000000000..04d9918a12 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PricingService.md @@ -0,0 +1,540 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PricingService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PricingService + +Allows retrieval of prices. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`PricingService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### featureFlagRouter + +• `Protected` `Readonly` **featureFlagRouter**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:25 + +___ + +### getProductPricing\_ + +• `Private` **getProductPricing\_**: `any` + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:69 + +___ + +### getProductVariantPricing\_ + +• `Private` **getProductVariantPricing\_**: `any` + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:41 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### priceSelectionStrategy + +• `Protected` `Readonly` **priceSelectionStrategy**: [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:23 + +___ + +### productVariantService + +• `Protected` `Readonly` **productVariantService**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:24 + +___ + +### regionService + +• `Protected` `Readonly` **regionService**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:21 + +___ + +### taxProviderService + +• `Protected` `Readonly` **taxProviderService**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:22 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### calculateTaxes + +▸ **calculateTaxes**(`variantPricing`, `productRates`): [`TaxedPricing`](../modules/internal-8.md#taxedpricing) + +Gets the prices for a product variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantPricing` | [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing) | the prices retrieved from a variant | +| `productRates` | [`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[] | the tax rates that the product has applied | + +#### Returns + +[`TaxedPricing`](../modules/internal-8.md#taxedpricing) + +The tax related variant prices. + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:40 + +___ + +### collectPricingContext + +▸ **collectPricingContext**(`context`): `Promise`<[`PricingContext`](../modules/internal-8.md#pricingcontext)\> + +Collects additional information necessary for completing the price +selection. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | the price selection context to use | + +#### Returns + +`Promise`<[`PricingContext`](../modules/internal-8.md#pricingcontext)\> + +The pricing context + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:33 + +___ + +### getProductPricing + +▸ **getProductPricing**(`product`, `context`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\>\> + +Gets all the variant prices for a product. All the product's variants will +be fetched. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `product` | [`Pick`](../modules/internal-1.md#pick)<[`Product`](internal-3.Product.md), ``"id"`` \| ``"variants"``\> | the product to get pricing for. | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | the price selection context to use | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\>\> + +A map of variant ids to their corresponding prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:77 + +___ + +### getProductPricingById + +▸ **getProductPricingById**(`productId`, `context`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\>\> + +Gets all the variant prices for a product by the product id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the id of the product to get prices for | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | the price selection context to use | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\>\> + +A map of variant ids to their corresponding prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:84 + +___ + +### getProductVariantPricing + +▸ **getProductVariantPricing**(`variant`, `context`): `Promise`<[`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\> + +Gets the prices for a product variant. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variant` | [`Pick`](../modules/internal-1.md#pick)<[`ProductVariant`](internal-3.ProductVariant.md), ``"id"`` \| ``"product_id"``\> | | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) \| [`PricingContext`](../modules/internal-8.md#pricingcontext) | the price selection context to use | + +#### Returns + +`Promise`<[`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\> + +The product variant prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:48 + +___ + +### getProductVariantPricingById + +▸ **getProductVariantPricingById**(`variantId`, `context`): `Promise`<[`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\> + +Gets the prices for a product variant by a variant id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of the variant to get prices for | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) \| [`PricingContext`](../modules/internal-8.md#pricingcontext) | the price selection context to use | + +#### Returns + +`Promise`<[`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing)\> + +The product variant prices + +**`Deprecated`** + +Use [getProductVariantsPricing](internal-8.internal.PricingService.md#getproductvariantspricing) instead. + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:56 + +___ + +### getProductVariantsPricing + +▸ **getProductVariantsPricing**(`data`, `context`): `Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing); }\> + +Gets the prices for a collection of variants. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | { `quantity?`: `number` ; `variantId`: `string` }[] | | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) \| [`PricingContext`](../modules/internal-8.md#pricingcontext) | the price selection context to use | + +#### Returns + +`Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../modules/internal-8.md#productvariantpricing); }\> + +The product variant prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:63 + +___ + +### getShippingOptionPricing + +▸ **getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<[`PricedShippingOption`](../modules/internal-8.md#pricedshippingoption)\> + +Gets the prices for a shipping option. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingOption` | [`ShippingOption`](internal-3.ShippingOption.md) | the shipping option to get prices for | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) \| [`PricingContext`](../modules/internal-8.md#pricingcontext) | the price selection context to use | + +#### Returns + +`Promise`<[`PricedShippingOption`](../modules/internal-8.md#pricedshippingoption)\> + +The shipping option prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:105 + +___ + +### setProductPrices + +▸ **setProductPrices**(`products`, `context?`): `Promise`<([`Product`](internal-3.Product.md) \| [`PricedProduct`](../modules/internal-8.md#pricedproduct))[]\> + +Set additional prices on a list of products. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `products` | [`Product`](internal-3.Product.md)[] | list of products on which to set additional prices | +| `context?` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | the price selection context to use | + +#### Returns + +`Promise`<([`Product`](internal-3.Product.md) \| [`PricedProduct`](../modules/internal-8.md#pricedproduct))[]\> + +A list of products with variants decorated with prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:98 + +___ + +### setShippingOptionPrices + +▸ **setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<[`PricedShippingOption`](../modules/internal-8.md#pricedshippingoption)[]\> + +Set additional prices on a list of shipping options. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingOptions` | [`ShippingOption`](internal-3.ShippingOption.md)[] | list of shipping options on which to set additional prices | +| `context?` | [`Omit`](../modules/internal-1.md#omit)<[`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext), ``"region_id"``\> | the price selection context to use | + +#### Returns + +`Promise`<[`PricedShippingOption`](../modules/internal-8.md#pricedshippingoption)[]\> + +A list of shipping options with prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:112 + +___ + +### setVariantPrices + +▸ **setVariantPrices**(`variants`, `context?`): `Promise`<[`PricedVariant`](../modules/internal-8.md#pricedvariant)[]\> + +Set additional prices on a list of product variants. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variants` | [`ProductVariant`](internal-3.ProductVariant.md)[] | | +| `context?` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | the price selection context to use | + +#### Returns + +`Promise`<[`PricedVariant`](../modules/internal-8.md#pricedvariant)[]\> + +A list of products with variants decorated with prices + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:91 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PricingService`](internal-8.internal.PricingService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PricingService`](internal-8.internal.PricingService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md new file mode 100644 index 0000000000..4759a96233 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCategoryService.md @@ -0,0 +1,549 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCategoryService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductCategoryService + +Provides layer to manipulate product categories. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductCategoryService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:18 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productCategoryRepo\_ + +• `Protected` `Readonly` **productCategoryRepo\_**: `TreeRepository`<[`ProductCategory`](internal-3.ProductCategory.md)\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:17 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:19 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addProducts + +▸ **addProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> + +Add a batch of product to a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | The id of the product category on which to add the products | +| `productIds` | `string`[] | The products ids to attach to the product category | + +#### Returns + +`Promise`<`void`\> + +the product category on which the products have been added + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:90 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`productCategoryInput`): `Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +Creates a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryInput` | [`CreateProductCategoryInput`](../modules/internal-8.md#createproductcategoryinput) | parameters to create a product category | + +#### Returns + +`Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +created product category + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:69 + +___ + +### delete + +▸ **delete**(`productCategoryId`): `Promise`<`void`\> + +Deletes a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | is the id of the product category to delete | + +#### Returns + +`Promise`<`void`\> + +a promise + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:83 + +___ + +### fetchReorderConditions + +▸ `Protected` **fetchReorderConditions**(`productCategory`, `input`, `shouldDeleteElement?`): [`ReorderConditions`](../modules/internal-8.md#reorderconditions) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategory` | [`ProductCategory`](internal-3.ProductCategory.md) | +| `input` | [`UpdateProductCategoryInput`](../modules/internal-8.md#updateproductcategoryinput) | +| `shouldDeleteElement?` | `boolean` | + +#### Returns + +[`ReorderConditions`](../modules/internal-8.md#reorderconditions) + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:98 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`, `treeSelector?`): `Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> + +Lists product category based on the provided parameters and includes the count of +product category that match the query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`TreeQuerySelector`](../modules/internal-8.internal.md#treequeryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | Filter options for product category. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCategory`](internal-3.ProductCategory.md)\> | Configuration for query. | +| `treeSelector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | Filter options for product category tree relations | + +#### Returns + +`Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> + +an array containing the product category as + the first element and the total count of product category that matches the query + as the second element. + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:35 + +___ + +### performReordering + +▸ `Protected` **performReordering**(`repository`, `conditions`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `repository` | `TreeRepository`<[`ProductCategory`](internal-3.ProductCategory.md)\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } | +| `conditions` | [`ReorderConditions`](../modules/internal-8.md#reorderconditions) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:99 + +___ + +### removeProducts + +▸ **removeProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> + +Remove a batch of product from a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | The id of the product category on which to remove the products | +| `productIds` | `string`[] | The products ids to remove from the product category | + +#### Returns + +`Promise`<`void`\> + +the product category on which the products have been removed + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:97 + +___ + +### retrieve + +▸ **retrieve**(`productCategoryId`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +Retrieves a product category by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | the id of the product category to retrieve. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCategory`](internal-3.ProductCategory.md)\> | the config of the product category to retrieve. | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | +| `treeSelector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | + +#### Returns + +`Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +the product category. + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:53 + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`handle`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +Retrieves a product category by handle. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `handle` | `string` | the handle of the category | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCategory`](internal-3.ProductCategory.md)\> | the config of the product category to retrieve. | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | +| `treeSelector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | + +#### Returns + +`Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +the product category. + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:63 + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +A generic retrieve for fining product categories by different attributes. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCategory`](internal-3.ProductCategory.md)\> | the config of the product category to retrieve. | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | +| `treeSelector?` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\> | | + +#### Returns + +`Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +the product category. + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:44 + +___ + +### shiftSiblings + +▸ `Protected` **shiftSiblings**(`repository`, `conditions`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `repository` | `TreeRepository`<[`ProductCategory`](internal-3.ProductCategory.md)\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } | +| `conditions` | [`ReorderConditions`](../modules/internal-8.md#reorderconditions) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:100 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### transformParentIdToEntity + +▸ `Protected` **transformParentIdToEntity**(`productCategoryInput`): `Promise`<[`CreateProductCategoryInput`](../modules/internal-8.md#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../modules/internal-8.md#updateproductcategoryinput)\> + +Accepts an input object and transforms product_category_id +into product_category entity. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryInput` | [`CreateProductCategoryInput`](../modules/internal-8.md#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../modules/internal-8.md#updateproductcategoryinput) | params used to create/update | + +#### Returns + +`Promise`<[`CreateProductCategoryInput`](../modules/internal-8.md#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../modules/internal-8.md#updateproductcategoryinput)\> + +transformed productCategoryInput + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:107 + +___ + +### update + +▸ **update**(`productCategoryId`, `productCategoryInput`): `Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +Updates a product category + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productCategoryId` | `string` | id of product category to update | +| `productCategoryInput` | [`UpdateProductCategoryInput`](../modules/internal-8.md#updateproductcategoryinput) | parameters to update in product category | + +#### Returns + +`Promise`<[`ProductCategory`](internal-3.ProductCategory.md)\> + +updated product category + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:76 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductCategoryService`](internal-8.internal.ProductCategoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductCategoryService`](internal-8.internal.ProductCategoryService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md new file mode 100644 index 0000000000..f18b709ba2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductCollectionService.md @@ -0,0 +1,457 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductCollectionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductCollectionService + +Provides layer to manipulate product collections. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductCollectionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:23 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productCollectionRepository\_ + +• `Protected` `Readonly` **productCollectionRepository\_**: `Repository`<[`ProductCollection`](internal-3.ProductCollection.md)\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductCollection`](internal-3.ProductCollection.md)\>) => `Promise`<[[`ProductCollection`](internal-3.ProductCollection.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:24 + +___ + +### productRepository\_ + +• `Protected` `Readonly` **productRepository\_**: `Repository`<[`Product`](internal-3.Product.md)\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](../modules/internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](internal-3.Product.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:25 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `PRODUCTS_ADDED` | `string` | +| `PRODUCTS_REMOVED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:26 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addProducts + +▸ **addProducts**(`collectionId`, `productIds`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `collectionId` | `string` | +| `productIds` | `string`[] | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:67 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`collection`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +Creates a product collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `collection` | [`CreateProductCollection`](../modules/internal-8.md#createproductcollection) | the collection to create | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +created collection + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:53 + +___ + +### delete + +▸ **delete**(`collectionId`): `Promise`<`void`\> + +Deletes a product collection idempotently + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `collectionId` | `string` | id of collection to delete | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:66 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)[]\> + +Lists product collections + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductCollection`](internal-3.ProductCollection.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | +| `config?` | `Object` | the config to be used for find | +| `config.skip` | `number` | - | +| `config.take` | `number` | - | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:75 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductCollection`](internal-3.ProductCollection.md)[], `number`]\> + +Lists product collections and add count. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`ListAndCountSelector`](../modules/internal-8.md#listandcountselector) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCollection`](internal-3.ProductCollection.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[[`ProductCollection`](internal-3.ProductCollection.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:88 + +___ + +### removeProducts + +▸ **removeProducts**(`collectionId`, `productIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `collectionId` | `string` | +| `productIds` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:68 + +___ + +### retrieve + +▸ **retrieve**(`collectionId`, `config?`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +Retrieves a product collection by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `collectionId` | `string` | the id of the collection to retrieve. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCollection`](internal-3.ProductCollection.md)\> | the config of the collection to retrieve. | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +the collection. + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:40 + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +Retrieves a product collection by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `collectionHandle` | `string` | the handle of the collection to retrieve. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductCollection`](internal-3.ProductCollection.md)\> | query config for request | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +the collection. + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:47 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`collectionId`, `update`): `Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +Updates a product collection + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `collectionId` | `string` | id of collection to update | +| `update` | [`UpdateProductCollection`](../modules/internal-8.md#updateproductcollection) | update object | + +#### Returns + +`Promise`<[`ProductCollection`](internal-3.ProductCollection.md)\> + +update collection + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:60 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductCollectionService`](internal-8.internal.ProductCollectionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductCollectionService`](internal-8.internal.ProductCollectionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md new file mode 100644 index 0000000000..e23a2bf0e9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductService.md @@ -0,0 +1,866 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/product.d.ts:40 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/product.d.ts:41 + +___ + +### imageRepository\_ + +• `Protected` `Readonly` **imageRepository\_**: `Repository`<[`Image`](internal-3.Image.md)\> & { `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`Image`](internal-3.Image.md)\>[]) => `Promise`<[`Image`](internal-3.Image.md)[]\> ; `upsertImages`: (`imageUrls`: `string`[]) => `Promise`<[`Image`](internal-3.Image.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product.d.ts:36 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productCategoryRepository\_ + +• `Protected` `Readonly` **productCategoryRepository\_**: `TreeRepository`<[`ProductCategory`](internal-3.ProductCategory.md)\> & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`ProductCategory`](internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/product.d.ts:37 + +___ + +### productOptionRepository\_ + +• `Protected` `Readonly` **productOptionRepository\_**: `Repository`<[`ProductOption`](internal-3.ProductOption.md)\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:31 + +___ + +### productRepository\_ + +• `Protected` `Readonly` **productRepository\_**: `Repository`<[`Product`](internal-3.Product.md)\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](../modules/internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](internal-3.Product.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product.d.ts:32 + +___ + +### productTagRepository\_ + +• `Protected` `Readonly` **productTagRepository\_**: `Repository`<[`ProductTag`](internal-3.ProductTag.md)\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductTag`](internal-3.ProductTag.md)\>) => `Promise`<[[`ProductTag`](internal-3.ProductTag.md)[], `number`]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`ProductTag`](internal-3.ProductTag.md)\>[]) => `Promise`<[`ProductTag`](internal-3.ProductTag.md)[]\> ; `listTagsByUsage`: (`take?`: `number`) => `Promise`<[`ProductTag`](internal-3.ProductTag.md)[]\> ; `upsertTags`: (`tags`: [`UpsertTagsInput`](../modules/internal-8.md#upserttagsinput)) => `Promise`<[`ProductTag`](internal-3.ProductTag.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product.d.ts:35 + +___ + +### productTypeRepository\_ + +• `Protected` `Readonly` **productTypeRepository\_**: `Repository`<[`ProductType`](internal-3.ProductType.md)\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductType`](internal-3.ProductType.md)\>) => `Promise`<[[`ProductType`](internal-3.ProductType.md)[], `number`]\> ; `upsertType`: (`type?`: [`UpsertTypeInput`](../modules/internal-8.md#upserttypeinput)) => `Promise`<``null`` \| [`ProductType`](internal-3.ProductType.md)\> } + +#### Defined in + +packages/medusa/dist/services/product.d.ts:34 + +___ + +### productVariantRepository\_ + +• `Protected` `Readonly` **productVariantRepository\_**: `Repository`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:33 + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/product.d.ts:38 + +___ + +### searchService\_ + +• `Protected` `Readonly` **searchService\_**: [`SearchService`](internal-8.internal.SearchService.md) + +#### Defined in + +packages/medusa/dist/services/product.d.ts:39 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` `Readonly` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/product.d.ts:43 + +___ + +### IndexName + +▪ `Static` `Readonly` **IndexName**: ``"products"`` + +#### Defined in + +packages/medusa/dist/services/product.d.ts:42 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addOption + +▸ **addOption**(`productId`, `optionTitle`): `Promise`<[`Product`](internal-3.Product.md)\> + +Adds an option to a product. Options can, for example, be "Size", "Color", +etc. Will update all the products variants with a dummy value for the newly +created option. The same option cannot be added more than once. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the product to apply the new option to | +| `optionTitle` | `string` | the display title of the option, e.g. "Size" | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the result of the model update operation + +#### Defined in + +packages/medusa/dist/services/product.d.ts:159 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### count + +▸ **count**(`selector?`): `Promise`<`number`\> + +Return the total number of documents in database + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Product`](internal-3.Product.md)\> | the selector to choose products by | + +#### Returns + +`Promise`<`number`\> + +the result of the count operation + +#### Defined in + +packages/medusa/dist/services/product.d.ts:75 + +___ + +### create + +▸ **create**(`productObject`): `Promise`<[`Product`](internal-3.Product.md)\> + +Creates a product. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productObject` | [`CreateProductInput`](../modules/internal-8.md#createproductinput) | the product to create | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +resolves to the creation result. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:132 + +___ + +### delete + +▸ **delete**(`productId`): `Promise`<`void`\> + +Deletes a product from a given product id. The product's associated +variants will also be deleted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the id of the product to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product.d.ts:150 + +___ + +### deleteOption + +▸ **deleteOption**(`productId`, `optionId`): `Promise`<`void` \| [`Product`](internal-3.Product.md)\> + +Delete an option from a product. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the product to delete an option from | +| `optionId` | `string` | the option to delete | + +#### Returns + +`Promise`<`void` \| [`Product`](internal-3.Product.md)\> + +the updated product + +#### Defined in + +packages/medusa/dist/services/product.d.ts:184 + +___ + +### filterProductsBySalesChannel + +▸ **filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<[`Product`](internal-3.Product.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productIds` | `string`[] | +| `salesChannelId` | `string` | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)[]\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:117 + +___ + +### isProductInSalesChannels + +▸ **isProductInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> + +Check if the product is assigned to at least one of the provided sales channels. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | product id | +| `salesChannelIds` | `string`[] | an array of sales channel ids | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:126 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Product`](internal-3.Product.md)[]\> + +Lists products based on the provided parameters. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`ProductSelector`](../modules/internal-8.md#productselector) | an object that defines rules to filter products by | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | object that defines the scope for what should be returned | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product.d.ts:57 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> + +Lists products based on the provided parameters and includes the count of +products that match the query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`ProductSelector`](../modules/internal-8.md#productselector) | an object that defines rules to filter products by | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | object that defines the scope for what should be returned | + +#### Returns + +`Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> + +an array containing the products as + the first element and the total count of products that matches the query + as the second element. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:69 + +___ + +### listTagsByUsage + +▸ **listTagsByUsage**(`take?`): `Promise`<[`ProductTag`](internal-3.ProductTag.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `take?` | `number` | + +#### Returns + +`Promise`<[`ProductTag`](internal-3.ProductTag.md)[]\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:119 + +___ + +### listTypes + +▸ **listTypes**(): `Promise`<[`ProductType`](internal-3.ProductType.md)[]\> + +#### Returns + +`Promise`<[`ProductType`](internal-3.ProductType.md)[]\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:118 + +___ + +### prepareListQuery\_ + +▸ `Protected` **prepareListQuery_**(`selector`, `config`): `Object` + +Temporary method to be used in place we need custom query strategy to prevent typeorm bug + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableProductProps`](internal-8.FilterableProductProps.md) \| [`Selector`](../modules/internal-8.internal.md#selector)<[`Product`](internal-3.Product.md)\> | +| `config` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `q` | `string` | +| `query` | [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1) | +| `relations` | keyof [`Product`](internal-3.Product.md)[] | + +#### Defined in + +packages/medusa/dist/services/product.d.ts:198 + +___ + +### reorderVariants + +▸ **reorderVariants**(`productId`, `variantOrder`): `Promise`<[`Product`](internal-3.Product.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productId` | `string` | +| `variantOrder` | `string`[] | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +#### Defined in + +packages/medusa/dist/services/product.d.ts:160 + +___ + +### retrieve + +▸ **retrieve**(`productId`, `config?`): `Promise`<[`Product`](internal-3.Product.md)\> + +Gets a product by id. +Throws in case of DB Error and if product was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | id of the product to get. | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | object that defines what should be included in the query response | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the result of the find one operation. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:84 + +___ + +### retrieveByExternalId + +▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Product`](internal-3.Product.md)\> + +Gets a product by external id. +Throws in case of DB Error and if product was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `externalId` | `string` | handle of the product to get. | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | details about what to get from the product | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the result of the find one operation. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:100 + +___ + +### retrieveByHandle + +▸ **retrieveByHandle**(`productHandle`, `config?`): `Promise`<[`Product`](internal-3.Product.md)\> + +Gets a product by handle. +Throws in case of DB Error and if product was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productHandle` | `string` | handle of the product to get. | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | details about what to get from the product | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the result of the find one operation. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:92 + +___ + +### retrieveOptionByTitle + +▸ **retrieveOptionByTitle**(`title`, `productId`): `Promise`<``null`` \| [`ProductOption`](internal-3.ProductOption.md)\> + +Retrieve product's option by title. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `title` | `string` | title of the option | +| `productId` | `string` | id of a product | + +#### Returns + +`Promise`<``null`` \| [`ProductOption`](internal-3.ProductOption.md)\> + +product option + +#### Defined in + +packages/medusa/dist/services/product.d.ts:177 + +___ + +### retrieveVariants + +▸ **retrieveVariants**(`productId`, `config?`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +Gets all variants belonging to a product. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the id of the product to get variants from. | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | The config to select and configure relations etc... | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +an array of variants + +#### Defined in + +packages/medusa/dist/services/product.d.ts:116 + +___ + +### retrieve\_ + +▸ **retrieve_**(`selector`, `config?`): `Promise`<[`Product`](internal-3.Product.md)\> + +Gets a product by selector. +Throws in case of DB Error and if product was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Product`](internal-3.Product.md)\> | selector object | +| `config?` | [`FindProductConfig`](../modules/internal-8.md#findproductconfig) | object that defines what should be included in the query response | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the result of the find one operation. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:109 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`productId`, `update`): `Promise`<[`Product`](internal-3.Product.md)\> + +Updates a product. Product variant updates should use dedicated methods, +e.g. `addVariant`, etc. The function will throw errors if metadata or +product variant updates are attempted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the id of the product. Must be a string that can be casted to an ObjectId | +| `update` | [`UpdateProductInput`](../modules/internal-8.md#updateproductinput) | an object with the update values. | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/product.d.ts:142 + +___ + +### updateOption + +▸ **updateOption**(`productId`, `optionId`, `data`): `Promise`<[`Product`](internal-3.Product.md)\> + +Updates a product's option. Throws if the call tries to update an option +not associated with the product. Throws if the updated title already exists. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productId` | `string` | the product whose option we are updating | +| `optionId` | `string` | the id of the option we are updating | +| `data` | [`ProductOptionInput`](../modules/internal-8.md#productoptioninput) | the data to update the option with | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)\> + +the updated product + +#### Defined in + +packages/medusa/dist/services/product.d.ts:169 + +___ + +### updateShippingProfile + +▸ **updateShippingProfile**(`productIds`, `profileId`): `Promise`<[`Product`](internal-3.Product.md)[]\> + +Assign a product to a profile, if a profile id null is provided then detach the product from the profile + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productIds` | `string` \| `string`[] | ID or IDs of the products to update | +| `profileId` | ``null`` \| `string` | Shipping profile ID to update the shipping options with | + +#### Returns + +`Promise`<[`Product`](internal-3.Product.md)[]\> + +updated products + +#### Defined in + +packages/medusa/dist/services/product.d.ts:191 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductService`](internal-8.internal.ProductService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductService`](internal-8.internal.ProductService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md new file mode 100644 index 0000000000..68022f477c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTaxRate.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTaxRate + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductTaxRate + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:8 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:10 + +___ + +### product + +• `Optional` **product**: [`Product`](internal-3.Product.md) + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:6 + +___ + +### product\_id + +• **product\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:4 + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:5 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](internal-3.TaxRate.md) + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/product-tax-rate.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md new file mode 100644 index 0000000000..3a9ce4886a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeService.md @@ -0,0 +1,274 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTypeService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductTypeService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductTypeService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### typeRepository\_ + +• `Protected` `Readonly` **typeRepository\_**: `Repository`<[`ProductType`](internal-3.ProductType.md)\> & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`ProductType`](internal-3.ProductType.md)\>) => `Promise`<[[`ProductType`](internal-3.ProductType.md)[], `number`]\> ; `upsertType`: (`type?`: [`UpsertTypeInput`](../modules/internal-8.md#upserttypeinput)) => `Promise`<``null`` \| [`ProductType`](internal-3.ProductType.md)\> } + +#### Defined in + +packages/medusa/dist/services/product-type.d.ts:6 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ProductType`](internal-3.ProductType.md)[]\> + +Lists product types + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductType`](internal-3.ProductType.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductType`](internal-3.ProductType.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[`ProductType`](internal-3.ProductType.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-type.d.ts:25 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductType`](internal-3.ProductType.md)[], `number`]\> + +Lists product types and adds count. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ProductType`](internal-3.ProductType.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductType`](internal-3.ProductType.md)\> | the config to be used for find | + +#### Returns + +`Promise`<[[`ProductType`](internal-3.ProductType.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-type.d.ts:35 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`): `Promise`<[`ProductType`](internal-3.ProductType.md)\> + +Gets a product type by id. +Throws in case of DB Error and if product was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | id of the product to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductType`](internal-3.ProductType.md)\> | object that defines what should be included in the query response | + +#### Returns + +`Promise`<[`ProductType`](internal-3.ProductType.md)\> + +the result of the find one operation. + +#### Defined in + +packages/medusa/dist/services/product-type.d.ts:18 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductTypeService`](internal-8.internal.ProductTypeService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductTypeService`](internal-8.internal.ProductTypeService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md new file mode 100644 index 0000000000..90bac9c402 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductTypeTaxRate.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductTypeTaxRate + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductTypeTaxRate + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:8 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:10 + +___ + +### product\_type + +• `Optional` **product\_type**: [`ProductType`](internal-3.ProductType.md) + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:6 + +___ + +### product\_type\_id + +• **product\_type\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:4 + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:5 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](internal-3.TaxRate.md) + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/product-type-tax-rate.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md new file mode 100644 index 0000000000..bde738e266 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantInventoryService.md @@ -0,0 +1,674 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantInventoryService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductVariantInventoryService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductVariantInventoryService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cacheService\_ + +• `Protected` `Readonly` **cacheService\_**: [`ICacheService`](../interfaces/internal-8.ICacheService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:32 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:31 + +___ + +### getAvailabilityContext + +• `Private` **getAvailabilityContext**: `any` + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:132 + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:30 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Overrides + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:24 + +___ + +### productVariantService\_ + +• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:28 + +___ + +### salesChannelInventoryService\_ + +• `Protected` `Readonly` **salesChannelInventoryService\_**: [`SalesChannelInventoryService`](internal-8.internal.SalesChannelInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:27 + +___ + +### salesChannelLocationService\_ + +• `Protected` `Readonly` **salesChannelLocationService\_**: [`SalesChannelLocationService`](internal-8.internal.SalesChannelLocationService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:26 + +___ + +### stockLocationService\_ + +• `Protected` `Readonly` **stockLocationService\_**: [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:29 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Overrides + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:25 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### adjustInventory + +▸ **adjustInventory**(`variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts inventory of a variant on a location + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `locationId` | `string` | location id | +| `quantity` | `number` | quantity to adjust | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:130 + +___ + +### adjustReservationsQuantityByLineItem + +▸ **adjustReservationsQuantityByLineItem**(`lineItemId`, `variantId`, `locationId`, `quantity`): `Promise`<`void`\> + +Adjusts the quantity of reservations for a line item by a given amount. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItemId` | `string` | The ID of the line item | +| `variantId` | `string` | The ID of the variant | +| `locationId` | `string` | The ID of the location to prefer adjusting quantities at | +| `quantity` | `number` | The amount to adjust the quantity by | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:109 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### attachInventoryItem + +▸ **attachInventoryItem**(`attachments`): `Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +Attach a variant to an inventory item + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `attachments` | { `inventoryItemId`: `string` ; `requiredQuantity?`: `number` ; `variantId`: `string` }[] | + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +the variant inventory item + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:83 + +▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variantId` | `string` | +| `inventoryItemId` | `string` | +| `requiredQuantity?` | `number` | + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:88 + +___ + +### confirmInventory + +▸ **confirmInventory**(`variantId`, `quantity`, `context?`): `Promise`<[`Boolean`](../modules/internal-3.md#boolean)\> + +confirms if requested inventory is available + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | id of the variant to confirm inventory for | +| `quantity` | `number` | quantity of inventory to confirm is available | +| `context?` | `Object` | optionally include a sales channel if applicable | +| `context.salesChannelId?` | ``null`` \| `string` | - | + +#### Returns + +`Promise`<[`Boolean`](../modules/internal-3.md#boolean)\> + +boolean indicating if inventory is available + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:41 + +___ + +### deleteReservationsByLineItem + +▸ **deleteReservationsByLineItem**(`lineItemId`, `variantId`, `quantity`): `Promise`<`void`\> + +delete a reservation of variant quantity + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItemId` | `string` \| `string`[] | line item id | +| `variantId` | `string` | variant id | +| `quantity` | `number` | quantity to release | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:123 + +___ + +### detachInventoryItem + +▸ **detachInventoryItem**(`inventoryItemId`, `variantId?`): `Promise`<`void`\> + +Remove a variant from an inventory item + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `inventoryItemId` | `string` | inventory item id | +| `variantId?` | `string` | variant id or undefined if all the variants will be affected | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:94 + +___ + +### getVariantQuantityFromVariantInventoryItems + +▸ **getVariantQuantityFromVariantInventoryItems**(`variantInventoryItems`, `channelId`): `Promise`<`number`\> + +Get the quantity of a variant from a list of variantInventoryItems +The inventory quantity of the variant should be equal to the inventory +item with the smallest stock, adjusted for quantity required to fulfill +the given variant. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantInventoryItems` | [`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[] | List of inventoryItems for a given variant, These must all be for the same variant | +| `channelId` | `string` | Sales channel id to fetch availability for | + +#### Returns + +`Promise`<`number`\> + +The available quantity of the variant from the inventoryItems + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:144 + +___ + +### listByItem + +▸ **listByItem**(`itemIds`): `Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +list registered inventory items + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemIds` | `string`[] | list inventory item ids | + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +list of inventory items + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:57 + +___ + +### listByVariant + +▸ **listByVariant**(`variantId`): `Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +List inventory items for a specific variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` \| `string`[] | variant id | + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)[]\> + +variant inventory items for the variant id + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:63 + +___ + +### listInventoryItemsByVariant + +▸ **listInventoryItemsByVariant**(`variantId`): `Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[]\> + +lists inventory items for a given variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | + +#### Returns + +`Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[]\> + +lidt of inventory items for the variant + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:75 + +___ + +### listVariantsByItem + +▸ **listVariantsByItem**(`itemId`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +lists variant by inventory item id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemId` | `string` | item id | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +a list of product variants that are associated with the item id + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:69 + +___ + +### reserveQuantity + +▸ **reserveQuantity**(`variantId`, `quantity`, `context?`): `Promise`<`void` \| [`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[]\> + +Reserves a quantity of a variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | variant id | +| `quantity` | `number` | quantity to reserve | +| `context?` | [`ReserveQuantityContext`](../modules/internal-8.md#reservequantitycontext) | optional parameters | + +#### Returns + +`Promise`<`void` \| [`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[]\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:101 + +___ + +### retrieve + +▸ **retrieve**(`inventoryItemId`, `variantId`): `Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)\> + +Retrieves a product variant inventory item by its inventory item ID and variant ID. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `inventoryItemId` | `string` | The ID of the inventory item to retrieve. | +| `variantId` | `string` | The ID of the variant to retrieve. | + +#### Returns + +`Promise`<[`ProductVariantInventoryItem`](internal-3.ProductVariantInventoryItem.md)\> + +A promise that resolves with the product variant inventory item. + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:51 + +___ + +### setProductAvailability + +▸ **setProductAvailability**(`products`, `salesChannelId`): `Promise`<([`Product`](internal-3.Product.md) \| [`PricedProduct`](../modules/internal-8.md#pricedproduct))[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `products` | ([`Product`](internal-3.Product.md) \| [`PricedProduct`](../modules/internal-8.md#pricedproduct))[] | +| `salesChannelId` | `undefined` \| `string` \| `string`[] | + +#### Returns + +`Promise`<([`Product`](internal-3.Product.md) \| [`PricedProduct`](../modules/internal-8.md#pricedproduct))[]\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:133 + +___ + +### setVariantAvailability + +▸ **setVariantAvailability**(`variants`, `salesChannelId`, `availabilityContext?`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[] \| [`PricedVariant`](../modules/internal-8.md#pricedvariant)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variants` | [`ProductVariant`](internal-3.ProductVariant.md)[] \| [`PricedVariant`](../modules/internal-8.md#pricedvariant)[] | +| `salesChannelId` | `undefined` \| `string` \| `string`[] | +| `availabilityContext?` | [`AvailabilityContext`](../modules/internal-8.md#availabilitycontext) | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[] \| [`PricedVariant`](../modules/internal-8.md#pricedvariant)[]\> + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:131 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### validateInventoryAtLocation + +▸ **validateInventoryAtLocation**(`items`, `locationId`): `Promise`<`void`\> + +Validate stock at a location for fulfillment items + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `items` | [`Omit`](../modules/internal-1.md#omit)<[`LineItem`](internal-3.LineItem.md), ``"beforeInsert"``\>[] | Fulfillment Line items to validate quantities for | +| `locationId` | `string` | Location to validate stock at | + +#### Returns + +`Promise`<`void`\> + +nothing if successful, throws error if not + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:116 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md new file mode 100644 index 0000000000..c86521fc0d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantMoneyAmount.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantMoneyAmount + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductVariantMoneyAmount + +Base abstract entity for all entities + +## Hierarchy + +- [`SoftDeletableEntity`](internal-1.SoftDeletableEntity.md) + + ↳ **`ProductVariantMoneyAmount`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/product-variant-money-amount.d.ts:5 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[created_at](internal-1.SoftDeletableEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### deleted\_at + +• **deleted\_at**: ``null`` \| `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[deleted_at](internal-1.SoftDeletableEntity.md#deleted_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[id](internal-1.SoftDeletableEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### money\_amount\_id + +• **money\_amount\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant-money-amount.d.ts:3 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[SoftDeletableEntity](internal-1.SoftDeletableEntity.md).[updated_at](internal-1.SoftDeletableEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/product-variant-money-amount.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md new file mode 100644 index 0000000000..dad39fa593 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ProductVariantService.md @@ -0,0 +1,869 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ProductVariantService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ProductVariantService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ProductVariantService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cartRepository\_ + +• `Protected` `Readonly` **cartRepository\_**: `Repository`<[`Cart`](internal-3.Cart.md)\> & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](../modules/internal-1.md#omit)<`FindManyOptions`<[`Cart`](internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](internal-3.Cart.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:26 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### moneyAmountRepository\_ + +• `Protected` `Readonly` **moneyAmountRepository\_**: `Repository`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: [`PriceListPriceCreateInput`](../modules/internal-8.internal.md#pricelistpricecreateinput)[], `overrideExisting?`: `boolean`) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: [`ProductVariantPrice`](../modules/internal-8.md#productvariantprice)[] ; `variantId`: `string` }[], `prices?`: [`Price`](../modules/internal-8.md#price)[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`Currency`](internal-3.Currency.md) ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| [`PriceList`](internal-3.PriceList.md) ; `price_list_id`: ``null`` \| `string` ; `region?`: [`Region`](internal-3.Region.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](internal-3.ProductVariant.md)[] }[]\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList?`: `boolean`) => `Promise`<[[`MoneyAmount`](internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`MoneyAmount`](internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`Record`](../modules/internal.md#record)<`string`, [`MoneyAmount`](internal-3.MoneyAmount.md)[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`Currency`](internal-3.Currency.md) ; `currency_code`: `string` ; `deleted_at`: ``null`` \| `Date` ; `id`: `string` ; `max_quantity`: ``null`` \| `number` ; `min_quantity`: ``null`` \| `number` ; `price_list`: ``null`` \| [`PriceList`](internal-3.PriceList.md) ; `price_list_id`: ``null`` \| `string` ; `region?`: [`Region`](internal-3.Region.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](internal-3.ProductVariant.md)[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: [`Price`](../modules/internal-8.md#price)[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`MoneyAmount`](internal-3.MoneyAmount.md)\>[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: [`PriceListPriceUpdateInput`](../modules/internal-8.internal.md#pricelistpriceupdateinput)[]) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: [`Price`](../modules/internal-8.md#price)) => `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> } + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:24 + +___ + +### priceSelectionStrategy\_ + +• `Protected` `Readonly` **priceSelectionStrategy\_**: [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:23 + +___ + +### productOptionValueRepository\_ + +• `Protected` `Readonly` **productOptionValueRepository\_**: `Repository`<[`ProductOptionValue`](internal-3.ProductOptionValue.md)\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:25 + +___ + +### productRepository\_ + +• `Protected` `Readonly` **productRepository\_**: `Repository`<[`Product`](internal-3.Product.md)\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](../modules/internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](internal-3.Product.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:20 + +___ + +### productVariantRepository\_ + +• `Protected` `Readonly` **productVariantRepository\_**: `Repository`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:19 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:22 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:14 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addOptionValue + +▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](internal-3.ProductOptionValue.md)\> + +Adds option value to a variant. +Fails when product with variant does not exist or +if that product does not have an option with the given +option id. Fails if given variant is not found. +Option value must be of type string or number. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | +| `optionValue` | `string` | option value to add. | + +#### Returns + +`Promise`<[`ProductOptionValue`](internal-3.ProductOptionValue.md)\> + +the result of the update operation. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:145 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**<`TVariants`, `TOutput`\>(`productOrProductId`, `variants`): `Promise`<`TOutput`\> + +Creates an unpublished product variant. Will validate against parent product +to ensure that the variant can in fact be created. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TVariants` | extends [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput) \| [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput)[] | +| `TOutput` | `TVariants` extends [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput)[] ? [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput)[] : [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productOrProductId` | `string` \| [`Product`](internal-3.Product.md) | the product the variant will be added to | +| `variants` | [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput) \| [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput)[] | | + +#### Returns + +`Promise`<`TOutput`\> + +resolves to the creation result. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:58 + +___ + +### delete + +▸ **delete**(`variantIds`): `Promise`<`void`\> + +Deletes variant or variants. +Will never fail due to delete being idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantIds` | `string` \| `string`[] | the id of the variant to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:173 + +___ + +### deleteOptionValue + +▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\> + +Deletes option value from given variant. +Will never fail due to delete being idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:153 + +___ + +### getFreeTextQueryBuilder\_ + +▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +Lists variants based on the provided parameters and includes the count of +variants that match the query. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantRepo` | `Repository`<[`ProductVariant`](internal-3.ProductVariant.md)\> | the variant repository | +| `query` | [`FindWithRelationsOptions`](../modules/internal-8.md#findwithrelationsoptions) | object that defines the scope for what should be returned | +| `q?` | `string` | free text query | + +#### Returns + +`SelectQueryBuilder`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +an array containing the products as the first element and the total + count of products that matches the query as the second element. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:190 + +___ + +### getRegionPrice + +▸ **getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\> + +Gets the price specific to a region. If no region specific money amount +exists the function will try to use a currency price. If no default +currency price exists the function will throw an error. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of the variant to get price from | +| `context` | [`GetRegionPriceContext`](../modules/internal-8.md#getregionpricecontext) | context for getting region price | + +#### Returns + +`Promise`<``null`` \| `number`\> + +the price specific to the region + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:108 + +___ + +### isVariantInSalesChannels + +▸ **isVariantInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> + +Check if the variant is assigned to at least one of the provided sales channels. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | product variant id | +| `salesChannelIds` | `string`[] | an array of sales channel ids | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:180 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`FilterableProductVariantProps`](internal-8.FilterableProductVariantProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductVariant`](internal-3.ProductVariant.md)\> & [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | query config object for variant retrieval | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:165 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ProductVariant`](internal-3.ProductVariant.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`FilterableProductVariantProps`](internal-8.FilterableProductVariantProps.md) | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductVariant`](internal-3.ProductVariant.md)\> & [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | query config object for variant retrieval | + +#### Returns + +`Promise`<[[`ProductVariant`](internal-3.ProductVariant.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:159 + +___ + +### retrieve + +▸ **retrieve**(`variantId`, `config?`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +Gets a product variant by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of the product to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductVariant`](internal-3.ProductVariant.md)\> & [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | query config object for variant retrieval. | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +the product document. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:43 + +___ + +### retrieveBySKU + +▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +Gets a product variant by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `sku` | `string` | The unique stock keeping unit used to identify the product variant. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ProductVariant`](internal-3.ProductVariant.md)\> & [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | query config object for variant retrieval. | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +the product document. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:50 + +___ + +### setCurrencyPrice + +▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of the variant to set prices for | +| `price` | [`ProductVariantPrice`](../modules/internal-8.md#productvariantprice) | the price for the variant | + +#### Returns + +`Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> + +the result of the update operation + +**`Deprecated`** + +use addOrUpdateCurrencyPrices instead +Sets the default price for the given currency. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:124 + +___ + +### setRegionPrice + +▸ **setRegionPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of the variant to update | +| `price` | [`ProductVariantPrice`](../modules/internal-8.md#productvariantprice) | the price for the variant. | + +#### Returns + +`Promise`<[`MoneyAmount`](internal-3.MoneyAmount.md)\> + +the result of the update operation + +**`Deprecated`** + +use addOrUpdateRegionPrices instead +Sets the default price of a specific region + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:116 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`variantData`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +Updates a collection of variant. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantData` | { `updateData`: [`UpdateProductVariantInput`](../modules/internal-8.md#updateproductvariantinput) ; `variant`: [`ProductVariant`](internal-3.ProductVariant.md) }[] | a collection of variant and the data to update. | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:64 + +▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +Updates a variant. +Price updates should use dedicated methods. +The function will throw, if price updates are attempted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantOrVariantId` | `string` \| [`Partial`](../modules/internal-8.md#partial)<[`ProductVariant`](internal-3.ProductVariant.md)\> | variant or id of a variant. | +| `update` | [`UpdateProductVariantInput`](../modules/internal-8.md#updateproductvariantinput) | an object with the update values. | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:76 + +▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variantOrVariantId` | `string` \| [`Partial`](../modules/internal-8.md#partial)<[`ProductVariant`](internal-3.ProductVariant.md)\> | +| `update` | [`UpdateProductVariantInput`](../modules/internal-8.md#updateproductvariantinput) | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:77 + +___ + +### updateBatch + +▸ `Protected` **updateBatch**(`variantData`): `Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `variantData` | [`UpdateProductVariantData`](../modules/internal-8.md#updateproductvariantdata)[] | + +#### Returns + +`Promise`<[`ProductVariant`](internal-3.ProductVariant.md)[]\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:78 + +___ + +### updateOptionValue + +▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](internal-3.ProductOptionValue.md)\> + +Updates variant's option value. +Option value must be of type string or number. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the variant to decorate. | +| `optionId` | `string` | the option from product. | +| `optionValue` | `string` | option value to add. | + +#### Returns + +`Promise`<[`ProductOptionValue`](internal-3.ProductOptionValue.md)\> + +the result of the update operation. + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:133 + +___ + +### updateVariantPrices + +▸ **updateVariantPrices**(`data`): `Promise`<`void`\> + +Updates variant/prices collection. +Deletes any prices that are not in the update object, and is not associated with a price list. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`UpdateVariantPricesData`](../modules/internal-8.md#updatevariantpricesdata)[] | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:85 + +▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> + +Updates a variant's prices. +Deletes any prices that are not in the update object, and is not associated with a price list. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantId` | `string` | the id of variant | +| `prices` | [`ProductVariantPrice`](../modules/internal-8.md#productvariantprice)[] | the update prices | + +#### Returns + +`Promise`<`void`\> + +empty promise + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:93 + +___ + +### updateVariantPricesBatch + +▸ `Protected` **updateVariantPricesBatch**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`UpdateVariantPricesData`](../modules/internal-8.md#updatevariantpricesdata)[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:94 + +___ + +### upsertCurrencyPrices + +▸ **upsertCurrencyPrices**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | { `price`: [`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`ProductVariantPrice`](../modules/internal-8.md#productvariantprice), ``"currency_code"``\> ; `variantId`: `string` }[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:96 + +___ + +### upsertRegionPrices + +▸ **upsertRegionPrices**(`data`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`UpdateVariantRegionPriceData`](../modules/internal-8.md#updatevariantregionpricedata)[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:95 + +___ + +### validateVariantsToCreate\_ + +▸ `Protected` **validateVariantsToCreate_**(`product`, `variants`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](internal-3.Product.md) | +| `variants` | [`CreateProductVariantInput`](../modules/internal-8.md#createproductvariantinput)[] | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/services/product-variant.d.ts:191 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ProductVariantService`](internal-8.internal.ProductVariantService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md new file mode 100644 index 0000000000..5a79816e2b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKey.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PublishableApiKey + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PublishableApiKey + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`PublishableApiKey`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key.d.ts:7 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### created\_by + +• **created\_by**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### revoked\_at + +• `Optional` **revoked\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key.d.ts:5 + +___ + +### revoked\_by + +• **revoked\_by**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key.d.ts:4 + +___ + +### title + +• **title**: `string` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key.d.ts:6 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md new file mode 100644 index 0000000000..db2353c4d9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.PublishableApiKeySalesChannel.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: PublishableApiKeySalesChannel + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PublishableApiKeySalesChannel + +## Properties + +### publishable\_key\_id + +• **publishable\_key\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key-sales-channel.d.ts:3 + +___ + +### sales\_channel\_id + +• **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/publishable-api-key-sales-channel.d.ts:2 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md new file mode 100644 index 0000000000..dae3d4f108 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.RegionService.md @@ -0,0 +1,781 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: RegionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).RegionService + +Provides layer to manipulate regions. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`RegionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### countryRepository\_ + +• `Protected` `Readonly` **countryRepository\_**: `Repository`<[`Country`](internal-3.Country.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:46 + +___ + +### currencyRepository\_ + +• `Protected` `Readonly` **currencyRepository\_**: `Repository`<[`Currency`](internal-3.Currency.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:47 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/region.d.ts:41 + +___ + +### featureFlagRouter\_ + +• `Protected` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/region.d.ts:40 + +___ + +### fulfillmentProviderRepository\_ + +• `Protected` `Readonly` **fulfillmentProviderRepository\_**: `Repository`<[`FulfillmentProvider`](internal-3.FulfillmentProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:49 + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/region.d.ts:44 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### paymentProviderRepository\_ + +• `Protected` `Readonly` **paymentProviderRepository\_**: `Repository`<[`PaymentProvider`](internal-3.PaymentProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:48 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/region.d.ts:43 + +___ + +### regionRepository\_ + +• `Protected` `Readonly` **regionRepository\_**: `Repository`<[`Region`](internal-3.Region.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:45 + +___ + +### storeService\_ + +• `Protected` `Readonly` **storeService\_**: [`StoreService`](internal-8.internal.StoreService.md) + +#### Defined in + +packages/medusa/dist/services/region.d.ts:42 + +___ + +### taxProviderRepository\_ + +• `Protected` `Readonly` **taxProviderRepository\_**: `Repository`<[`TaxProvider`](internal-3.TaxProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/region.d.ts:50 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/region.d.ts:35 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addCountry + +▸ **addCountry**(`regionId`, `code`): `Promise`<[`Region`](internal-3.Region.md)\> + +Adds a country to the region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to add a country to | +| `code` | `string` | a 2 digit alphanumeric ISO country code. | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:154 + +___ + +### addFulfillmentProvider + +▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](internal-3.Region.md)\> + +Adds a fulfillment provider that is available in the region. Fails if the +provider doesn't exist. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to add the provider to | +| `providerId` | `string` | the provider to add to the region | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:180 + +___ + +### addPaymentProvider + +▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](internal-3.Region.md)\> + +Adds a payment provider that is available in the region. Fails if the +provider doesn't exist. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to add the provider to | +| `providerId` | `string` | the provider to add to the region | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:171 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Region`](internal-3.Region.md)\> + +Creates a region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreateRegionInput`](../modules/internal-8.md#createregioninput) | the unvalidated region | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the newly created region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:58 + +___ + +### delete + +▸ **delete**(`regionId`): `Promise`<`void`\> + +Deletes a region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to delete | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation + +#### Defined in + +packages/medusa/dist/services/region.d.ts:146 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`Region`](internal-3.Region.md)[]\> + +Lists all regions based on a query + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Region`](internal-3.Region.md)\> | query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Region`](internal-3.Region.md)\> | configuration settings | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)[]\> + +result of the find operation + +#### Defined in + +packages/medusa/dist/services/region.d.ts:131 + +___ + +### listAndCount + +▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Region`](internal-3.Region.md)[], `number`]\> + +Lists all regions based on a query and returns them along with count + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Region`](internal-3.Region.md)\> | query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Region`](internal-3.Region.md)\> | configuration settings | + +#### Returns + +`Promise`<[[`Region`](internal-3.Region.md)[], `number`]\> + +result of the find operation + +#### Defined in + +packages/medusa/dist/services/region.d.ts:139 + +___ + +### removeCountry + +▸ **removeCountry**(`regionId`, `code`): `Promise`<[`Region`](internal-3.Region.md)\> + +Removes a country from a Region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to remove from | +| `code` | `string` | a 2 digit alphanumeric ISO country code to remove | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:162 + +___ + +### removeFulfillmentProvider + +▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](internal-3.Region.md)\> + +Removes a fulfillment provider from a region. Is idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to remove the provider from | +| `providerId` | `string` | the provider to remove from the region | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:196 + +___ + +### removePaymentProvider + +▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](internal-3.Region.md)\> + +Removes a payment provider from a region. Is idempotent. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to remove the provider from | +| `providerId` | `string` | the provider to remove from the region | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the updated Region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:188 + +___ + +### retrieve + +▸ **retrieve**(`regionId`, `config?`): `Promise`<[`Region`](internal-3.Region.md)\> + +Retrieves a region by its id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the id of the region to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Region`](internal-3.Region.md)\> | configuration settings | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the region + +#### Defined in + +packages/medusa/dist/services/region.d.ts:123 + +___ + +### retrieveByCountryCode + +▸ **retrieveByCountryCode**(`code`, `config?`): `Promise`<[`Region`](internal-3.Region.md)\> + +Retrieve a region by country code. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | a 2 digit alphanumeric ISO country code | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Region`](internal-3.Region.md)\> | region find config | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +a Region with country code + +#### Defined in + +packages/medusa/dist/services/region.d.ts:108 + +___ + +### retrieveByName + +▸ **retrieveByName**(`name`): `Promise`<[`Region`](internal-3.Region.md)\> + +Retrieves a region by name. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | the name of the region to retrieve | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +region with the matching name + +#### Defined in + +packages/medusa/dist/services/region.d.ts:115 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`regionId`, `update`): `Promise`<[`Region`](internal-3.Region.md)\> + +Updates a region + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionId` | `string` | the region to update | +| `update` | [`UpdateRegionInput`](../modules/internal-8.md#updateregioninput) | the data to update the region with | + +#### Returns + +`Promise`<[`Region`](internal-3.Region.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/region.d.ts:66 + +___ + +### validateCountry + +▸ `Protected` **validateCountry**(`code`, `regionId`): `Promise`<[`Country`](internal-3.Country.md)\> + +Validates a country code. Will normalize the code before checking for +existence. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | a 2 digit alphanumeric ISO country code | +| `regionId` | `string` | the id of the current region to check against | + +#### Returns + +`Promise`<[`Country`](internal-3.Country.md)\> + +the validated Country + +#### Defined in + +packages/medusa/dist/services/region.d.ts:100 + +___ + +### validateCurrency + +▸ `Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\> + +Validates a currency code. Will throw if the currency code doesn't exist. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `currencyCode` | `string` | an ISO currency code | + +#### Returns + +`Promise`<`void`\> + +void + +**`Throws`** + +if the provided currency code is invalid + +#### Defined in + +packages/medusa/dist/services/region.d.ts:91 + +___ + +### validateFields + +▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<[`Region`](internal-3.Region.md)\>\> + +Validates fields for creation and updates. If the region already exists +the id can be passed to check that country updates are allowed. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`CreateRegionInput`](../modules/internal-8.md#createregioninput) \| [`UpdateRegionInput`](../modules/internal-8.md#updateregioninput) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `regionData` | [`Omit`](../modules/internal-1.md#omit)<`T`, ``"metadata"`` \| ``"currency_code"``\> | the region data to validate | +| `id?` | `T` extends [`UpdateRegionInput`](../modules/internal-8.md#updateregioninput) ? `string` : `undefined` | optional id of the region to check against | + +#### Returns + +`Promise`<`DeepPartial`<[`Region`](internal-3.Region.md)\>\> + +the validated region data + +#### Defined in + +packages/medusa/dist/services/region.d.ts:75 + +___ + +### validateTaxRate + +▸ `Protected` **validateTaxRate**(`taxRate`): `void` + +Validates a tax rate. Will throw if the tax rate is not between 0 and 1. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `taxRate` | `number` | a number representing the tax rate of the region | + +#### Returns + +`void` + +void + +**`Throws`** + +if the tax rate isn't number between 0-100 + +#### Defined in + +packages/medusa/dist/services/region.d.ts:83 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`RegionService`](internal-8.internal.RegionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`RegionService`](internal-8.internal.RegionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md new file mode 100644 index 0000000000..5c3a466e28 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnReasonService.md @@ -0,0 +1,307 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnReasonService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ReturnReasonService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ReturnReasonService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### retReasonRepo\_ + +• `Protected` `Readonly` **retReasonRepo\_**: `Repository`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:12 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateReturnReason`](../modules/internal-8.md#createreturnreason) | + +#### Returns + +`Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:14 + +___ + +### delete + +▸ **delete**(`returnReasonId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnReasonId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:29 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ReturnReason`](internal-3.ReturnReason.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ReturnReason`](internal-3.ReturnReason.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ReturnReason`](internal-3.ReturnReason.md)\> | config object | + +#### Returns + +`Promise`<[`ReturnReason`](internal-3.ReturnReason.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:21 + +___ + +### retrieve + +▸ **retrieve**(`returnReasonId`, `config?`): `Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +Gets an order by id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `returnReasonId` | `string` | id of order to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ReturnReason`](internal-3.ReturnReason.md)\> | config object | + +#### Returns + +`Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +the order document + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:28 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `data` | [`UpdateReturnReason`](../modules/internal-8.md#updatereturnreason) | + +#### Returns + +`Promise`<[`ReturnReason`](internal-3.ReturnReason.md)\> + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:15 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ReturnReasonService`](internal-8.internal.ReturnReasonService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ReturnReasonService`](internal-8.internal.ReturnReasonService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md new file mode 100644 index 0000000000..c8c533d3f9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ReturnService.md @@ -0,0 +1,601 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ReturnService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ReturnService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ReturnService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:37 + +___ + +### fulfillmentProviderService\_ + +• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:33 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:30 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### orderService\_ + +• `Protected` `Readonly` **orderService\_**: [`OrderService`](internal-8.internal.OrderService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:35 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:36 + +___ + +### returnItemRepository\_ + +• `Protected` `Readonly` **returnItemRepository\_**: `Repository`<[`ReturnItem`](internal-3.ReturnItem.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:29 + +___ + +### returnReasonService\_ + +• `Protected` `Readonly` **returnReasonService\_**: [`ReturnReasonService`](internal-8.internal.ReturnReasonService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:34 + +___ + +### returnRepository\_ + +• `Protected` `Readonly` **returnRepository\_**: `Repository`<[`Return`](internal-3.Return.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:28 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:32 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:31 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/return.d.ts:27 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`returnId`): `Promise`<[`Return`](internal-3.Return.md)\> + +Cancels a return if possible. Returns can be canceled if it has not been received. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `returnId` | `string` | the id of the return to cancel. | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +the updated Return + +#### Defined in + +packages/medusa/dist/services/return.d.ts:70 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`Return`](internal-3.Return.md)\> + +Creates a return request for an order, with given items, and a shipping +method. If no refund amount is provided the refund amount is calculated from +the return lines and the shipping cost. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreateReturnInput`](../modules/internal-8.md#createreturninput) | data to use for the return e.g. shipping_method, items or refund_amount | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +the created return + +#### Defined in + +packages/medusa/dist/services/return.d.ts:111 + +___ + +### fulfill + +▸ **fulfill**(`returnId`): `Promise`<[`Return`](internal-3.Return.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnId` | `string` | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:112 + +___ + +### getFulfillmentItems + +▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](internal-3.LineItem.md) & { `note?`: `string` ; `reason_id?`: `string` }[]\> + +Retrieves the order line items, given an array of items + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to get line items from | +| `items` | [`OrdersReturnItem`](internal-8.OrdersReturnItem.md)[] | the items to get | +| `transformer` | [`Transformer`](../modules/internal-8.md#transformer) | a function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array. | + +#### Returns + +`Promise`<[`LineItem`](internal-3.LineItem.md) & { `note?`: `string` ; `reason_id?`: `string` }[]\> + +the line items generated by the transformer. + +#### Defined in + +packages/medusa/dist/services/return.d.ts:49 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Return`](internal-3.Return.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Return`](internal-3.Return.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Return`](internal-3.Return.md)\> | the config object for find | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/return.d.ts:58 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Return`](internal-3.Return.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Return`](internal-3.Return.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Return`](internal-3.Return.md)\> | the config object for find | + +#### Returns + +`Promise`<[[`Return`](internal-3.Return.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/return.d.ts:64 + +___ + +### receive + +▸ **receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`, `context?`): `Promise`<[`Return`](internal-3.Return.md)\> + +Registers a previously requested return as received. This will create a +refund to the customer. If the returned items don't match the requested +items the return status will be updated to requires_action. This behaviour +is useful in situations where a custom refund amount is requested, but the +returned items are not matching the requested items. Setting the +allowMismatch argument to true, will process the return, ignoring any +mismatches. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `returnId` | `string` | the orderId to return to | +| `receivedItems` | [`OrdersReturnItem`](internal-8.OrdersReturnItem.md)[] | the items received after return. | +| `refundAmount?` | `number` | the amount to return | +| `allowMismatch?` | `boolean` | whether to ignore return/received product mismatch | +| `context?` | `Object` | - | +| `context.locationId?` | `string` | - | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/return.d.ts:128 + +___ + +### retrieve + +▸ **retrieve**(`returnId`, `config?`): `Promise`<[`Return`](internal-3.Return.md)\> + +Retrieves a return by its id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `returnId` | `string` | the id of the return to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Return`](internal-3.Return.md)\> | the config object | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +the return + +#### Defined in + +packages/medusa/dist/services/return.d.ts:100 + +___ + +### retrieveBySwap + +▸ **retrieveBySwap**(`swapId`, `relations?`): `Promise`<[`Return`](internal-3.Return.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `swapId` | `string` | +| `relations?` | `string`[] | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:101 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`returnId`, `update`): `Promise`<[`Return`](internal-3.Return.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnId` | `string` | +| `update` | [`UpdateReturnInput`](../modules/internal-8.md#updatereturninput) | + +#### Returns + +`Promise`<[`Return`](internal-3.Return.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:102 + +___ + +### validateReturnLineItem + +▸ `Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `DeepPartial`<[`LineItem`](internal-3.LineItem.md)\> + +Checks that a given quantity of a line item can be returned. Fails if the +item is undefined or if the returnable quantity of the item is lower, than +the quantity that is requested to be returned. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `item?` | [`LineItem`](internal-3.LineItem.md) | the line item to check has sufficient returnable quantity. | +| `quantity?` | `number` | the quantity that is requested to be returned. | +| `additional?` | `Object` | the quantity that is requested to be returned. | +| `additional.note?` | `string` | - | +| `additional.reason_id?` | `string` | - | + +#### Returns + +`DeepPartial`<[`LineItem`](internal-3.LineItem.md)\> + +a line item where the quantity is set to the requested + return quantity. + +#### Defined in + +packages/medusa/dist/services/return.d.ts:90 + +___ + +### validateReturnStatuses + +▸ `Protected` **validateReturnStatuses**(`order`): `void` + +Checks that an order has the statuses necessary to complete a return. +fulfillment_status cannot be not_fulfilled or returned. +payment_status must be captured. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to check statuses on | + +#### Returns + +`void` + +**`Throws`** + +when statuses are not sufficient for returns. + +#### Defined in + +packages/medusa/dist/services/return.d.ts:78 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ReturnService`](internal-8.internal.ReturnService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ReturnService`](internal-8.internal.ReturnService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md new file mode 100644 index 0000000000..0168b5c71e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelInventoryService.md @@ -0,0 +1,243 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannelInventoryService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SalesChannelInventoryService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`SalesChannelInventoryService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-inventory.d.ts:13 + +___ + +### inventoryService\_ + +• `Protected` `Readonly` **inventoryService\_**: [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-inventory.d.ts:14 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### salesChannelLocationService\_ + +• `Protected` `Readonly` **salesChannelLocationService\_**: [`SalesChannelLocationService`](internal-8.internal.SalesChannelLocationService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-inventory.d.ts:12 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### retrieveAvailableItemQuantity + +▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> + +Retrieves the available quantity of an item across all sales channel locations + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | Sales channel id | +| `inventoryItemId` | `string` | Item id | + +#### Returns + +`Promise`<`number`\> + +available quantity of item across all sales channel locations + +#### Defined in + +packages/medusa/dist/services/sales-channel-inventory.d.ts:22 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelInventoryService`](internal-8.internal.SalesChannelInventoryService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SalesChannelInventoryService`](internal-8.internal.SalesChannelInventoryService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md new file mode 100644 index 0000000000..6714573e04 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelLocationService.md @@ -0,0 +1,318 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannelLocationService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SalesChannelLocationService + +Service for managing the stock locations of sales channels + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`SalesChannelLocationService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:16 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### salesChannelService\_ + +• `Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](internal-8.internal.SalesChannelService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:15 + +___ + +### stockLocationService\_ + +• `Protected` `Readonly` **stockLocationService\_**: [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:17 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### associateLocation + +▸ **associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> + +Associates a sales channel with a stock location. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The ID of the sales channel. | +| `locationId` | `string` | The ID of the stock location. | + +#### Returns + +`Promise`<`void`\> + +A promise that resolves when the association has been created. + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:32 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### listLocationIds + +▸ **listLocationIds**(`salesChannelId`): `Promise`<`string`[]\> + +Lists the stock locations associated with a sales channel. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` \| `string`[] | The ID of the sales channel. | + +#### Returns + +`Promise`<`string`[]\> + +A promise that resolves with an array of location IDs. + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:38 + +___ + +### listSalesChannelIds + +▸ **listSalesChannelIds**(`locationId`): `Promise`<`string`[]\> + +Lists the sales channels associated with a stock location. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `locationId` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +A promise that resolves with an array of sales channel IDs. + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:44 + +___ + +### removeLocation + +▸ **removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\> + +Removes an association between a sales channel and a stock location. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `locationId` | `string` | The ID of the stock location. | +| `salesChannelId?` | `string` | The ID of the sales channel or undefined if all the sales channel will be affected. | + +#### Returns + +`Promise`<`void`\> + +A promise that resolves when the association has been removed. + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:25 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](internal-8.internal.SalesChannelLocationService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SalesChannelLocationService`](internal-8.internal.SalesChannelLocationService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md new file mode 100644 index 0000000000..b7f0e68fb0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SalesChannelService.md @@ -0,0 +1,519 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SalesChannelService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SalesChannelService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`SalesChannelService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### eventBusService\_ + +• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:22 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### salesChannelRepository\_ + +• `Protected` `Readonly` **salesChannelRepository\_**: `Repository`<[`SalesChannel`](internal-3.SalesChannel.md)\> & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`ExtendedFindConfig`](../modules/internal-8.internal.md#extendedfindconfig)<[`SalesChannel`](internal-3.SalesChannel.md)\>) => `Promise`<[[`SalesChannel`](internal-3.SalesChannel.md)[], `number`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:21 + +___ + +### storeService\_ + +• `Protected` `Readonly` **storeService\_**: [`StoreService`](internal-8.internal.StoreService.md) + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:23 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:16 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addProducts + +▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Add a batch of product to a sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The id of the sales channel on which to add the products | +| `productIds` | `string`[] | The products ids to attach to the sales channel | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +the sales channel on which the products have been added + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:106 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Creates a SalesChannel + + This feature is under development and may change in the future. +To use this feature please enable the corresponding feature flag in your medusa backend project. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateSalesChannelInput`](../modules/internal-8.md#createsaleschannelinput) | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +the created channel + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:66 + +___ + +### createDefault + +▸ **createDefault**(): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Creates a default sales channel, if this does not already exist. + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +the sales channel + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:79 + +___ + +### delete + +▸ **delete**(`salesChannelId`): `Promise`<`void`\> + +Deletes a sales channel from + This feature is under development and may change in the future. +To use this feature please enable the corresponding feature flag in your medusa backend project. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | the id of the sales channel to delete | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:74 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`SalesChannel`](internal-3.SalesChannel.md)[], `number`]\> + +Lists sales channels based on the provided parameters and includes the count of +sales channels that match the query. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`QuerySelector`](../modules/internal-8.internal.md#queryselector)<[`SalesChannel`](internal-3.SalesChannel.md)\> | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`SalesChannel`](internal-3.SalesChannel.md)\> | + +#### Returns + +`Promise`<[[`SalesChannel`](internal-3.SalesChannel.md)[], `number`]\> + +an array containing the sales channels as + the first element and the total count of sales channels that matches the query + as the second element. + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:58 + +___ + +### listProductIdsBySalesChannelIds + +▸ **listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> + +List all product ids that belongs to the sales channels ids + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `salesChannelIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<{ `[salesChannelId: string]`: `string`[]; }\> + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:90 + +___ + +### removeProducts + +▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Remove a batch of product from a sales channel + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | The id of the sales channel on which to remove the products | +| `productIds` | `string`[] | The products ids to remove from the sales channel | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +the sales channel on which the products have been removed + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:99 + +___ + +### retrieve + +▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Retrieve a SalesChannel by id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `salesChannelId` | `string` | id of the channel to retrieve | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`SalesChannel`](internal-3.SalesChannel.md)\> | SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +a sales channel + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:42 + +___ + +### retrieveByName + +▸ **retrieveByName**(`name`, `config?`): `Promise`<`unknown`\> + +Find a sales channel by name. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `name` | `string` | of the sales channel | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`SalesChannel`](internal-3.SalesChannel.md)\> | find config | + +#### Returns + +`Promise`<`unknown`\> + +a sales channel with matching name + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:50 + +___ + +### retrieveDefault + +▸ **retrieveDefault**(): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +Retrieves the default sales channel. + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +the sales channel + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:84 + +___ + +### retrieve\_ + +▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +A generic retrieve used to find a sales channel by different attributes. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`SalesChannel`](internal-3.SalesChannel.md)\> | SC selector | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`SalesChannel`](internal-3.SalesChannel.md)\> | find config | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +a single SC matching the query or throws + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:32 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`salesChannelId`, `data`): `Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `salesChannelId` | `string` | +| `data` | [`Partial`](../modules/internal-8.md#partial)<[`CreateSalesChannelInput`](../modules/internal-8.md#createsaleschannelinput)\> | + +#### Returns + +`Promise`<[`SalesChannel`](internal-3.SalesChannel.md)\> + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:67 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SalesChannelService`](internal-8.internal.SalesChannelService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SalesChannelService`](internal-8.internal.SalesChannelService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md new file mode 100644 index 0000000000..5d886adf1d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SearchService.md @@ -0,0 +1,302 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SearchService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SearchService + +## Hierarchy + +- [`AbstractSearchService`](internal-8.AbstractSearchService.md) + + ↳ **`SearchService`** + +## Properties + +### isDefault + +• **isDefault**: `boolean` + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[isDefault](internal-8.AbstractSearchService.md#isdefault) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:9 + +___ + +### logger\_ + +• `Protected` `Readonly` **logger\_**: [`Logger`](../modules/internal-8.internal.md#logger) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:10 + +___ + +### options\_ + +• `Protected` `Readonly` **options\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[options_](internal-8.AbstractSearchService.md#options_) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:11 + +## Accessors + +### options + +• `get` **options**(): [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Returns + +[`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +AbstractSearchService.options + +#### Defined in + +packages/utils/dist/search/abstract-service.d.ts:5 + +## Methods + +### addDocuments + +▸ **addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> + +Used to index documents by the search engine provider + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `documents` | `unknown` | documents array to be indexed | +| `type` | `string` | of documents to be added (e.g: products, regions, orders, etc) | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[addDocuments](internal-8.AbstractSearchService.md#adddocuments) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:15 + +___ + +### createIndex + +▸ **createIndex**(`indexName`, `options`): `Promise`<`void`\> + +Used to create an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `options` | `unknown` | the options | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[createIndex](internal-8.AbstractSearchService.md#createindex) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:13 + +___ + +### deleteAllDocuments + +▸ **deleteAllDocuments**(`indexName`): `Promise`<`void`\> + +Used to delete all documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[deleteAllDocuments](internal-8.AbstractSearchService.md#deletealldocuments) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:18 + +___ + +### deleteDocument + +▸ **deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\> + +Used to delete document + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `document_id` | `string` \| `number` | the id of the document | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[deleteDocument](internal-8.AbstractSearchService.md#deletedocument) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:17 + +___ + +### getIndex + +▸ **getIndex**(`indexName`): `Promise`<`void`\> + +Used to get an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[getIndex](internal-8.AbstractSearchService.md#getindex) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:14 + +___ + +### replaceDocuments + +▸ **replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> + +Used to replace documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | +| `documents` | `unknown` | array of document objects that will replace existing documents | +| `type` | `string` | type of documents to be replaced (e.g: products, regions, orders, etc) | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[replaceDocuments](internal-8.AbstractSearchService.md#replacedocuments) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:16 + +___ + +### search + +▸ **search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\> + +Used to search for a document in an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `query` | `unknown` | the search query | +| `options` | `unknown` | any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options | + +#### Returns + +`Promise`<{ `hits`: `unknown`[] }\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[search](internal-8.AbstractSearchService.md#search) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:19 + +___ + +### updateSettings + +▸ **updateSettings**(`indexName`, `settings`): `Promise`<`void`\> + +Used to update the settings of an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `settings` | `unknown` | settings object | + +#### Returns + +`Promise`<`void`\> + +returns response from search engine provider + +#### Overrides + +[AbstractSearchService](internal-8.AbstractSearchService.md).[updateSettings](internal-8.AbstractSearchService.md#updatesettings) + +#### Defined in + +packages/medusa/dist/services/search.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md new file mode 100644 index 0000000000..9c0bc28a38 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingAddressPayload.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingAddressPayload + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ShippingAddressPayload + +## Properties + +### postal\_code + +• `Optional` **postal\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md new file mode 100644 index 0000000000..34bced2b35 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingOptionService.md @@ -0,0 +1,663 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingOptionService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ShippingOptionService + +Provides layer to manipulate profiles. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ShippingOptionService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:30 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### methodRepository\_ + +• `Protected` `Readonly` **methodRepository\_**: `Repository`<[`ShippingMethod`](internal-3.ShippingMethod.md)\> + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:29 + +___ + +### optionRepository\_ + +• `Protected` `Readonly` **optionRepository\_**: `Repository`<[`ShippingOption`](internal-3.ShippingOption.md)\> & { `upsertShippingProfile`: (`shippingOptionIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:28 + +___ + +### providerService\_ + +• `Protected` `Readonly` **providerService\_**: [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:25 + +___ + +### regionService\_ + +• `Protected` `Readonly` **regionService\_**: [`RegionService`](internal-8.internal.RegionService.md) + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:26 + +___ + +### requirementRepository\_ + +• `Protected` `Readonly` **requirementRepository\_**: `Repository`<[`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)\> + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:27 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### validateAndMutatePrice + +• `Private` **validateAndMutatePrice**: `any` + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:90 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addRequirement + +▸ **addRequirement**(`optionId`, `requirement`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +Adds a requirement to a shipping option. Only 1 requirement of each type +is allowed. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `string` | the option to add the requirement to. | +| `requirement` | [`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md) | the requirement for the option. | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +the result of update + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:130 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +Creates a new shipping option. Used both for outbound and inbound shipping +options. The difference is registered by the `is_return` field which +defaults to false. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`CreateShippingOptionInput`](../modules/internal-8.md#createshippingoptioninput) | the data to create shipping options | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:98 + +___ + +### createShippingMethod + +▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<[`ShippingMethod`](internal-3.ShippingMethod.md)\> + +Creates a shipping method for a given cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `string` | the id of the option to use for the method. | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the optional provider data to use. | +| `config` | [`CreateShippingMethodDto`](../modules/internal-8.md#createshippingmethoddto) | the cart to create the shipping method for. | + +#### Returns + +`Promise`<[`ShippingMethod`](internal-3.ShippingMethod.md)\> + +the resulting shipping method. + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:80 + +___ + +### delete + +▸ **delete**(`optionId`): `Promise`<`void` \| [`ShippingOption`](internal-3.ShippingOption.md)\> + +Deletes a profile with a given profile id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void` \| [`ShippingOption`](internal-3.ShippingOption.md)\> + +the result of the delete operation. + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:122 + +___ + +### deleteShippingMethods + +▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<[`ShippingMethod`](internal-3.ShippingMethod.md)[]\> + +Removes a given shipping method + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingMethods` | [`ShippingMethod`](internal-3.ShippingMethod.md) \| [`ShippingMethod`](internal-3.ShippingMethod.md)[] | the shipping method to remove | + +#### Returns + +`Promise`<[`ShippingMethod`](internal-3.ShippingMethod.md)[]\> + +removed shipping methods + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:72 + +___ + +### getPrice\_ + +▸ **getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\> + +Returns the amount to be paid for a shipping method. Will ask the +fulfillment provider to calculate the price if the shipping option has the +price type "calculated". + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | the shipping option to retrieve the price for. | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | the shipping data to retrieve the price. | +| `cart` | `undefined` \| [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the context in which the price should be retrieved. | + +#### Returns + +`Promise`<`number`\> + +the price of the shipping option. + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:155 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ShippingOption`](internal-3.ShippingOption.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ShippingOption`](internal-3.ShippingOption.md)\> | config object | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:44 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ShippingOption`](internal-3.ShippingOption.md)[], `number`]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ShippingOption`](internal-3.ShippingOption.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ShippingOption`](internal-3.ShippingOption.md)\> | config object | + +#### Returns + +`Promise`<[[`ShippingOption`](internal-3.ShippingOption.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:50 + +___ + +### removeRequirement + +▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| [`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)\> + +Removes a requirement from a shipping option + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `requirementId` | `any` | the id of the requirement to remove | + +#### Returns + +`Promise`<`void` \| [`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)\> + +the result of update + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:136 + +___ + +### retrieve + +▸ **retrieve**(`optionId`, `options?`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `any` | the id of the profile to get. | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ShippingOption`](internal-3.ShippingOption.md)\> | the options to get a profile | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +the profile document. + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:58 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`optionId`, `update`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +Updates a profile. Metadata updates and product updates should use +dedicated methods, e.g. `setMetadata`, etc. The function +will throw errors if metadata or product updates are attempted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `string` | the id of the option. Must be a string that can be casted to an ObjectId | +| `update` | [`UpdateShippingOptionInput`](../modules/internal-8.md#updateshippingoptioninput) | an object with the update values. | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:115 + +___ + +### updateShippingMethod + +▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| [`ShippingMethod`](internal-3.ShippingMethod.md)\> + +Updates a shipping method's associations. Useful when a cart is completed +and its methods should be copied to an order/swap entity. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `string` | the id of the shipping method to update | +| `update` | [`ShippingMethodUpdate`](../modules/internal-8.md#shippingmethodupdate) | the values to update the method with | + +#### Returns + +`Promise`<`undefined` \| [`ShippingMethod`](internal-3.ShippingMethod.md)\> + +the resulting shipping method + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:66 + +___ + +### updateShippingProfile + +▸ **updateShippingProfile**(`optionIds`, `profileId`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionIds` | `string` \| `string`[] | ID or IDs of the shipping options to update | +| `profileId` | `string` | Shipping profile ID to update the shipping options with | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +updated shipping options + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:143 + +___ + +### validateCartOption + +▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| [`ShippingOption`](internal-3.ShippingOption.md)\> + +Checks if a given option id is a valid option for a cart. If it is the +option is returned with the correct price. Throws when region_ids do not +match, or when the shipping option requirements are not satisfied. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | the option object to check | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart object to check against | + +#### Returns + +`Promise`<``null`` \| [`ShippingOption`](internal-3.ShippingOption.md)\> + +the validated shipping option + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:89 + +___ + +### validatePriceType\_ + +▸ **validatePriceType_**(`priceType`, `option`): `Promise`<[`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md)\> + +Validates a shipping option price + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `priceType` | [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) | the price to validate | +| `option` | [`ShippingOption`](internal-3.ShippingOption.md) | the option to validate against | + +#### Returns + +`Promise`<[`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md)\> + +the validated price + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:105 + +___ + +### validateRequirement\_ + +▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<[`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)\> + +Validates a requirement + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `requirement` | [`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md) | the requirement to validate | +| `optionId?` | `string` | the id to validate the requirement | + +#### Returns + +`Promise`<[`ShippingOptionRequirement`](internal-3.ShippingOptionRequirement.md)\> + +a validated shipping requirement + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:38 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md new file mode 100644 index 0000000000..f4ee068317 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md @@ -0,0 +1,635 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingProfileService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ShippingProfileService + +Provides layer to manipulate profiles. + +**`Implements`** + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`ShippingProfileService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### customShippingOptionService\_ + +• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:29 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:32 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productRepository\_ + +• `Protected` `Readonly` **productRepository\_**: `Repository`<[`Product`](internal-3.Product.md)\> & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](../modules/internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](../modules/internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](internal-3.Product.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:31 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:27 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:28 + +___ + +### shippingProfileRepository\_ + +• `Protected` `Readonly` **shippingProfileRepository\_**: `Repository`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> & { `findByProducts`: (`productIds`: `string` \| `string`[]) => `Promise`<{ `[product_id: string]`: [`ShippingProfile`](internal-3.ShippingProfile.md)[]; }\> } + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:30 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addProduct + +▸ **addProduct**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `profileId` | `string` | +| `productId` | `string` \| `string`[] | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +**`Deprecated`** + +use [addProducts](internal-8.internal.ShippingProfileService.md#addproducts) instead + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:95 + +___ + +### addProducts + +▸ **addProducts**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Adds a product or an array of products to the profile. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | `string` | the profile to add the products to. | +| `productId` | `string` \| `string`[] | the ID of the product or multiple products to add. | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the result of update + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:102 + +___ + +### addShippingOption + +▸ **addShippingOption**(`profileId`, `optionId`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Adds a shipping option to the profile. The shipping option can be used to +fulfill the products in the products field. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | `string` | the profile to apply the shipping option to | +| `optionId` | `string` \| `string`[] | the ID of the option or multiple options to add to the profile | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the result of the model update operation + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:117 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`profile`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Creates a new shipping profile. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profile` | [`CreateShippingProfile`](../modules/internal-8.md#createshippingprofile) | the shipping profile to create from | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the result of the create operation + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:74 + +___ + +### createDefault + +▸ **createDefault**(): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Creates a default shipping profile, if this does not already exist. + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the shipping profile + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:57 + +___ + +### createGiftCardDefault + +▸ **createGiftCardDefault**(): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Creates a default shipping profile, for gift cards if unless it already +exists. + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the shipping profile + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:68 + +___ + +### delete + +▸ **delete**(`profileId`): `Promise`<`void`\> + +Deletes a profile with a given profile id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | `string` | the id of the profile to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation. + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:91 + +___ + +### fetchCartOptions + +▸ **fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +Finds all the shipping profiles that cover the products in a cart, and +validates all options that are available for the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | `any` | the cart object to find shipping options for | + +#### Returns + +`Promise`<[`ShippingOption`](internal-3.ShippingOption.md)[]\> + +a list of the available shipping options + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:124 + +___ + +### getMapProfileIdsByProductIds + +▸ **getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productIds` | `string`[] | + +#### Returns + +`Promise`<`Map`<`string`, `string`\>\> + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:40 + +___ + +### getProfilesInCart + +▸ `Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\> + +Returns a list of all the productIds in the cart. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cart` | [`Cart`](internal-3.Cart.md) | the cart to extract products from | + +#### Returns + +`Promise`<`string`[]\> + +a list of product ids + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:130 + +___ + +### list + +▸ **list**(`selector?`, `config?`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector?` | [`Selector`](../modules/internal-8.internal.md#selector)<[`ShippingProfile`](internal-3.ShippingProfile.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ShippingProfile`](internal-3.ShippingProfile.md)\> | the config object for find | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:39 + +___ + +### removeProducts + +▸ **removeProducts**(`profileId`, `productId`): `Promise`<`void` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Removes a product or an array of products from the profile. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | ``null`` \| `string` | the profile to add the products to. | +| `productId` | `string` \| `string`[] | the ID of the product or multiple products to add. | + +#### Returns + +`Promise`<`void` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the result of update + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:109 + +___ + +### retrieve + +▸ **retrieve**(`profileId`, `options?`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Gets a profile by id. +Throws in case of DB Error and if profile was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | `string` | the id of the profile to get. | +| `options?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`ShippingProfile`](internal-3.ShippingProfile.md)\> | options opf the query. | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the profile document. + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:48 + +___ + +### retrieveDefault + +▸ **retrieveDefault**(): `Promise`<``null`` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +#### Returns + +`Promise`<``null`` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:52 + +___ + +### retrieveForProducts + +▸ **retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: [`ShippingProfile`](internal-3.ShippingProfile.md)[]; }\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<{ `[product_id: string]`: [`ShippingProfile`](internal-3.ShippingProfile.md)[]; }\> + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:49 + +___ + +### retrieveGiftCardDefault + +▸ **retrieveGiftCardDefault**(): `Promise`<``null`` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Retrieves the default gift card profile + +#### Returns + +`Promise`<``null`` \| [`ShippingProfile`](internal-3.ShippingProfile.md)\> + +the shipping profile for gift cards + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:62 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`profileId`, `update`): `Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +Updates a profile. Metadata updates and product updates should use +dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function +will throw errors if metadata or product updates are attempted. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `profileId` | `string` | the id of the profile. Must be a string that can be casted to an ObjectId | +| `update` | [`UpdateShippingProfile`](../modules/internal-8.md#updateshippingprofile) | an object with the update values. | + +#### Returns + +`Promise`<[`ShippingProfile`](internal-3.ShippingProfile.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:84 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md new file mode 100644 index 0000000000..def96293c3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingTaxRate.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: ShippingTaxRate + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ShippingTaxRate + +## Properties + +### created\_at + +• **created\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:8 + +___ + +### metadata + +• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:10 + +___ + +### rate\_id + +• **rate\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:5 + +___ + +### shipping\_option + +• `Optional` **shipping\_option**: [`ShippingOption`](internal-3.ShippingOption.md) + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:6 + +___ + +### shipping\_option\_id + +• **shipping\_option\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:4 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: [`TaxRate`](internal-3.TaxRate.md) + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:7 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Defined in + +packages/medusa/dist/models/shipping-tax-rate.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md new file mode 100644 index 0000000000..c770d86ef3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJob.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StagedJob + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StagedJob + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/staged-job.d.ts:6 + +___ + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/staged-job.d.ts:4 + +___ + +### event\_name + +• **event\_name**: `string` + +#### Defined in + +packages/medusa/dist/models/staged-job.d.ts:3 + +___ + +### id + +• **id**: `string` + +#### Defined in + +packages/medusa/dist/models/staged-job.d.ts:2 + +___ + +### options + +• **options**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/staged-job.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md new file mode 100644 index 0000000000..4642203643 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StagedJobService.md @@ -0,0 +1,260 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StagedJobService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StagedJobService + +Provides layer to manipulate users. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`StagedJobService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### stagedJobRepository\_ + +• `Protected` **stagedJobRepository\_**: `Repository`<[`StagedJob`](internal-8.internal.StagedJob.md)\> & { `insertBulk`: (`jobToCreates`: `_QueryDeepPartialEntity`<[`StagedJob`](internal-8.internal.StagedJob.md)\>[]) => `Promise`<[`StagedJob`](internal-8.internal.StagedJob.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/staged-job.d.ts:15 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`EmitData`](../modules/internal-8.md#emitdata)<`unknown`\> \| [`EmitData`](../modules/internal-8.md#emitdata)<`unknown`\>[] | + +#### Returns + +`Promise`<[`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Defined in + +packages/medusa/dist/services/staged-job.d.ts:19 + +___ + +### delete + +▸ **delete**(`stagedJobIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stagedJobIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/staged-job.d.ts:18 + +___ + +### list + +▸ **list**(`config`): `Promise`<[`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`StagedJob`](internal-8.internal.StagedJob.md)\> | + +#### Returns + +`Promise`<[`StagedJob`](internal-8.internal.StagedJob.md)[]\> + +#### Defined in + +packages/medusa/dist/services/staged-job.d.ts:17 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StagedJobService`](internal-8.internal.StagedJobService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`StagedJobService`](internal-8.internal.StagedJobService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md new file mode 100644 index 0000000000..21f89ae59b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.Store.md @@ -0,0 +1,177 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: Store + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).Store + +Base abstract entity for all entities + +## Hierarchy + +- [`BaseEntity`](internal-1.BaseEntity.md) + + ↳ **`Store`** + +## Properties + +### beforeInsert + +• `Private` **beforeInsert**: `any` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:16 + +___ + +### created\_at + +• **created\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[created_at](internal-1.BaseEntity.md#created_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:6 + +___ + +### currencies + +• **currencies**: [`Currency`](internal-3.Currency.md)[] + +#### Defined in + +packages/medusa/dist/models/store.d.ts:8 + +___ + +### default\_currency + +• **default\_currency**: [`Currency`](internal-3.Currency.md) + +#### Defined in + +packages/medusa/dist/models/store.d.ts:7 + +___ + +### default\_currency\_code + +• **default\_currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:6 + +___ + +### default\_location\_id + +• **default\_location\_id**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:12 + +___ + +### default\_sales\_channel + +• **default\_sales\_channel**: [`SalesChannel`](internal-3.SalesChannel.md) + +#### Defined in + +packages/medusa/dist/models/store.d.ts:15 + +___ + +### default\_sales\_channel\_id + +• **default\_sales\_channel\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:14 + +___ + +### id + +• **id**: `string` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[id](internal-1.BaseEntity.md#id) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:5 + +___ + +### invite\_link\_template + +• **invite\_link\_template**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:11 + +___ + +### metadata + +• **metadata**: ``null`` \| [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/models/store.d.ts:13 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:5 + +___ + +### payment\_link\_template + +• **payment\_link\_template**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:10 + +___ + +### swap\_link\_template + +• **swap\_link\_template**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/models/store.d.ts:9 + +___ + +### updated\_at + +• **updated\_at**: `Date` + +#### Inherited from + +[BaseEntity](internal-1.BaseEntity.md).[updated_at](internal-1.BaseEntity.md#updated_at) + +#### Defined in + +packages/medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md similarity index 50% rename from www/apps/docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md index e89a1d5f94..bfa4e90db2 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-36.StoreGetCollectionsParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCollectionsParams.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: StoreGetCollectionsParams -[internal](../modules/internal-36.md).StoreGetCollectionsParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetCollectionsParams ## Properties @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:108 +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:106 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:105 +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:103 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:106 +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:104 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:107 +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:105 ___ @@ -50,4 +54,4 @@ ___ #### Defined in -medusa/dist/api/routes/store/collections/list-collections.d.ts:109 +packages/medusa/dist/api/routes/store/collections/list-collections.d.ts:107 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md new file mode 100644 index 0000000000..7a7e75bef9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetCustomersCustomerOrdersPaginationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetCustomersCustomerOrdersPaginationParams + +## Hierarchy + +- **`StoreGetCustomersCustomerOrdersPaginationParams`** + + ↳ [`StoreGetCustomersCustomerOrdersParams`](internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:178 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:177 + +___ + +### limit + +• **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:175 + +___ + +### offset + +• **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:176 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md new file mode 100644 index 0000000000..ede4aaaa21 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md @@ -0,0 +1,209 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetCustomersCustomerOrdersParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetCustomersCustomerOrdersParams + +## Hierarchy + +- [`StoreGetCustomersCustomerOrdersPaginationParams`](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md) + + ↳ **`StoreGetCustomersCustomerOrdersParams`** + +## Properties + +### canceled\_at + +• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:194 + +___ + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:187 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:192 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:190 + +___ + +### display\_id + +• `Optional` **display\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:186 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:188 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[StoreGetCustomersCustomerOrdersPaginationParams](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md).[expand](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md#expand) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:178 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[StoreGetCustomersCustomerOrdersPaginationParams](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md).[fields](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md#fields) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:177 + +___ + +### fulfillment\_status + +• `Optional` **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal-3.FulfillmentStatus.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:184 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:181 + +___ + +### limit + +• **limit**: `number` + +#### Inherited from + +[StoreGetCustomersCustomerOrdersPaginationParams](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md).[limit](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:175 + +___ + +### offset + +• **offset**: `number` + +#### Inherited from + +[StoreGetCustomersCustomerOrdersPaginationParams](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md).[offset](internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:176 + +___ + +### payment\_status + +• `Optional` **payment\_status**: [`PaymentStatus`](../enums/internal-3.PaymentStatus.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:185 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:182 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:189 + +___ + +### status + +• `Optional` **status**: [`OrderStatus`](../enums/internal-3.OrderStatus.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:183 + +___ + +### tax\_rate + +• `Optional` **tax\_rate**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:191 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/list-orders.d.ts:193 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md new file mode 100644 index 0000000000..1d108eaf27 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetOrdersParams.md @@ -0,0 +1,71 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetOrdersParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetOrdersParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`StoreGetOrdersParams`** + +## Properties + +### display\_id + +• **display\_id**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:77 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:78 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: [`ShippingAddressPayload`](internal-8.internal.ShippingAddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/lookup-order.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md new file mode 100644 index 0000000000..1c29b1fc5d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetPaymentCollectionsParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetPaymentCollectionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetPaymentCollectionsParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`StoreGetPaymentCollectionsParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md new file mode 100644 index 0000000000..c31928d554 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductCategoriesCategoryParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductCategoriesCategoryParams + +## Hierarchy + +- [`FindParams`](internal-6.FindParams.md) + + ↳ **`StoreGetProductCategoriesCategoryParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[expand](internal-6.FindParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[FindParams](internal-6.FindParams.md).[fields](internal-6.FindParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md new file mode 100644 index 0000000000..998ac26b21 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductCategoriesParams.md @@ -0,0 +1,109 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductCategoriesParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductCategoriesParams + +## Hierarchy + +- [`StoreGetProductCategoriesParams_base`](../modules/internal-8.md#storegetproductcategoriesparams_base) + + ↳ **`StoreGetProductCategoriesParams`** + +## Properties + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +StoreGetProductCategoriesParams\_base.expand + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +StoreGetProductCategoriesParams\_base.fields + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:70 + +___ + +### include\_descendants\_tree + +• `Optional` **include\_descendants\_tree**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:72 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +StoreGetProductCategoriesParams\_base.limit + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +StoreGetProductCategoriesParams\_base.offset + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### parent\_category\_id + +• `Optional` **parent\_category\_id**: ``null`` \| `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:71 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md new file mode 100644 index 0000000000..b755efe084 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTagsParams.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductTagsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductTagsParams + +## Hierarchy + +- [`FindPaginationParams`](internal-4.FindPaginationParams.md) + + ↳ **`StoreGetProductTagsParams`** + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:122 + +___ + +### discount\_condition\_id + +• `Optional` **discount\_condition\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:125 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:119 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[FindPaginationParams](internal-4.FindPaginationParams.md).[limit](internal-4.FindPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:244 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[FindPaginationParams](internal-4.FindPaginationParams.md).[offset](internal-4.FindPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:243 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:124 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:120 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:123 + +___ + +### value + +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/list-product-tags.d.ts:121 diff --git a/www/apps/docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md similarity index 58% rename from www/apps/docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md rename to www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md index f473392a69..e6866a49c2 100644 --- a/www/apps/docs/content/references/js-client/classes/internal-44.StoreGetProductTypesParams.md +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductTypesParams.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Class: StoreGetProductTypesParams -[internal](../modules/internal-44.md).StoreGetProductTypesParams +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductTypesParams ## Hierarchy @@ -16,7 +20,7 @@ #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:135 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:126 ___ @@ -26,17 +30,17 @@ ___ #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:138 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:129 ___ ### id -• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) +• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:132 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:123 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:122 +packages/medusa/dist/types/common.d.ts:244 ___ @@ -64,7 +68,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:121 +packages/medusa/dist/types/common.d.ts:243 ___ @@ -74,7 +78,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:137 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:128 ___ @@ -84,7 +88,7 @@ ___ #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:133 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:124 ___ @@ -94,14 +98,14 @@ ___ #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:136 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:127 ___ ### value -• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-5.StringComparisonOperator.md) +• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal-6.StringComparisonOperator.md) #### Defined in -medusa/dist/api/routes/store/product-types/list-product-types.d.ts:134 +packages/medusa/dist/api/routes/store/product-types/list-product-types.d.ts:125 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md new file mode 100644 index 0000000000..e28a8d95a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsPaginationParams.md @@ -0,0 +1,115 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductsPaginationParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductsPaginationParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-8.PriceSelectionParams.md) + + ↳ **`StoreGetProductsPaginationParams`** + + ↳↳ [`StoreGetProductsParams`](internal-8.internal.StoreGetProductsParams.md) + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[cart_id](internal-8.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[currency_code](internal-8.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[expand](internal-8.PriceSelectionParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[fields](internal-8.PriceSelectionParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:193 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:192 + +___ + +### order + +• `Optional` **order**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:194 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[region_id](internal-8.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md new file mode 100644 index 0000000000..d90a9f795e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetProductsParams.md @@ -0,0 +1,265 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetProductsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetProductsParams + +## Hierarchy + +- [`StoreGetProductsPaginationParams`](internal-8.internal.StoreGetProductsPaginationParams.md) + + ↳ **`StoreGetProductsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[cart_id](internal-8.internal.StoreGetProductsPaginationParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### category\_id + +• `Optional` **category\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:207 + +___ + +### collection\_id + +• `Optional` **collection\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:199 + +___ + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:209 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[currency_code](internal-8.internal.StoreGetProductsPaginationParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### description + +• `Optional` **description**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:202 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[expand](internal-8.internal.StoreGetProductsPaginationParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[fields](internal-8.internal.StoreGetProductsPaginationParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### handle + +• `Optional` **handle**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:203 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:197 + +___ + +### include\_category\_children + +• `Optional` **include\_category\_children**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:208 + +___ + +### is\_giftcard + +• `Optional` **is\_giftcard**: `boolean` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:204 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[limit](internal-8.internal.StoreGetProductsPaginationParams.md#limit) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:193 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[offset](internal-8.internal.StoreGetProductsPaginationParams.md#offset) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:192 + +___ + +### order + +• `Optional` **order**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[order](internal-8.internal.StoreGetProductsPaginationParams.md#order) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:194 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:198 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[StoreGetProductsPaginationParams](internal-8.internal.StoreGetProductsPaginationParams.md).[region_id](internal-8.internal.StoreGetProductsPaginationParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:206 + +___ + +### tags + +• `Optional` **tags**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:200 + +___ + +### title + +• `Optional` **title**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:201 + +___ + +### type\_id + +• `Optional` **type\_id**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:205 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/products/list-products.d.ts:210 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md new file mode 100644 index 0000000000..94fbe340bb --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetRegionsParams.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetRegionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetRegionsParams + +## Properties + +### created\_at + +• `Optional` **created\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/list-regions.d.ts:100 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/list-regions.d.ts:98 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/list-regions.d.ts:99 + +___ + +### updated\_at + +• `Optional` **updated\_at**: [`DateComparisonOperator`](internal-2.DateComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/list-regions.d.ts:101 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md new file mode 100644 index 0000000000..85dad133b9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetShippingOptionsParams.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetShippingOptionsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetShippingOptionsParams + +## Properties + +### is\_return + +• `Optional` **is\_return**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:52 + +___ + +### product\_ids + +• `Optional` **product\_ids**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:50 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/list-options.d.ts:51 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md new file mode 100644 index 0000000000..29bb3a8110 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsParams.md @@ -0,0 +1,153 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetVariantsParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetVariantsParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-8.PriceSelectionParams.md) + + ↳ **`StoreGetVariantsParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[cart_id](internal-8.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[currency_code](internal-8.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[expand](internal-8.PriceSelectionParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[fields](internal-8.PriceSelectionParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### id + +• `Optional` **id**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:121 + +___ + +### ids + +• `Optional` **ids**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:119 + +___ + +### inventory\_quantity + +• `Optional` **inventory\_quantity**: `number` \| [`NumericalComparisonOperator`](internal-8.internal.NumericalComparisonOperator.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:123 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:117 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:118 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[region_id](internal-8.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:120 + +___ + +### title + +• `Optional` **title**: `string` \| `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/list-variants.d.ts:122 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md new file mode 100644 index 0000000000..f5dc0bf51e --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreGetVariantsVariantParams.md @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreGetVariantsVariantParams + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreGetVariantsVariantParams + +## Hierarchy + +- [`PriceSelectionParams`](internal-8.PriceSelectionParams.md) + + ↳ **`StoreGetVariantsVariantParams`** + +## Properties + +### cart\_id + +• `Optional` **cart\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[cart_id](internal-8.PriceSelectionParams.md#cart_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:3 + +___ + +### currency\_code + +• `Optional` **currency\_code**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[currency_code](internal-8.PriceSelectionParams.md#currency_code) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:5 + +___ + +### expand + +• `Optional` **expand**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[expand](internal-8.PriceSelectionParams.md#expand) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:239 + +___ + +### fields + +• `Optional` **fields**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[fields](internal-8.PriceSelectionParams.md#fields) + +#### Defined in + +packages/medusa/dist/types/common.d.ts:240 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Inherited from + +[PriceSelectionParams](internal-8.PriceSelectionParams.md).[region_id](internal-8.PriceSelectionParams.md#region_id) + +#### Defined in + +packages/medusa/dist/types/price-selection.d.ts:4 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/get-variant.d.ts:61 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md new file mode 100644 index 0000000000..12ce3712b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePaymentCollectionSessionsReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePaymentCollectionSessionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePaymentCollectionSessionsReq + +**`Schema`** + +StorePaymentCollectionSessionsReq +type: object +required: + - provider_id +properties: + provider_id: + type: string + description: The ID of the Payment Provider. + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/manage-payment-session.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md new file mode 100644 index 0000000000..af0b63d503 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostAuthReq.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostAuthReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostAuthReq + +**`Schema`** + +StorePostAuthReq +type: object +required: + - email + - password +properties: + email: + type: string + description: The Customer's email. + password: + type: string + description: The Customer's password. + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/create-session.d.ts:75 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/create-session.d.ts:76 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md new file mode 100644 index 0000000000..05e7b1a00f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartReq.md @@ -0,0 +1,102 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartReq + +**`Schema`** + +StorePostCartReq +type: object +properties: + region_id: + type: string + description: "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency. + If this parameter is not provided, the first region in the store is used by default." + sales_channel_id: + type: string + description: "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not + exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, + the specified sales channel must be within the scope of the publishable API key's resources. If you add a publishable API key in the header of this request, + you don't specify a sales channel ID, and the publishable API key is associated with one sales channel, that sales channel will be attached to the cart. + If no sales channel is passed and no publishable API key header is passed or the publishable API key isn't associated with any sales channel, + the cart will not be associated with any sales channel." + country_code: + type: string + description: "The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + items: + description: "An array of product variants to generate line items from." + type: array + items: + type: object + required: + - variant_id + - quantity + properties: + variant_id: + description: The ID of the Product Variant. + type: string + quantity: + description: The quantity to add into the cart. + type: integer + context: + description: "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" + type: object + example: + ip: "::1" + user_agent: "Chrome" + +## Properties + +### context + +• `Optional` **context**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:105 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:103 + +___ + +### items + +• `Optional` **items**: [`Item`](internal-8.internal.Item.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:104 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:102 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-cart.d.ts:106 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md new file mode 100644 index 0000000000..3c92ce5aaa --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md @@ -0,0 +1,44 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartLineItemsItemReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartLineItemsItemReq + +**`Schema`** + +StorePostCartsCartLineItemsItemReq +type: object +required: + - quantity +properties: + quantity: + type: number + description: The quantity of the line item in the cart. + metadata: + type: object + description: An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged." + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-line-item.d.ts:76 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-line-item.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md new file mode 100644 index 0000000000..d81d2e4a28 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartLineItemsReq.md @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartLineItemsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartLineItemsReq + +**`Schema`** + +StorePostCartsCartLineItemsReq +type: object +required: + - variant_id + - quantity +properties: + variant_id: + type: string + description: The id of the Product Variant to generate the Line Item from. + quantity: + type: number + description: The quantity of the Product Variant to add to the Line Item. + metadata: + type: object + description: An optional key-value map with additional details about the Line Item. + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:83 + +___ + +### quantity + +• **quantity**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:82 + +___ + +### variant\_id + +• **variant\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/create-line-item/index.d.ts:81 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md new file mode 100644 index 0000000000..477c9f6cd0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartPaymentSessionReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartPaymentSessionReq + +**`Schema`** + +StorePostCartsCartPaymentSessionReq +type: object +required: + - provider_id +properties: + provider_id: + type: string + description: The ID of the Payment Provider. + +## Properties + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/set-payment-session.d.ts:69 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md new file mode 100644 index 0000000000..e7a9a286e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartPaymentSessionUpdateReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartPaymentSessionUpdateReq + +**`Schema`** + +StorePostCartsCartPaymentSessionUpdateReq +type: object +required: + - data +properties: + data: + type: object + description: The data to update the payment session with. + +## Properties + +### data + +• **data**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-payment-session.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md new file mode 100644 index 0000000000..9e71dabbec --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartReq.md @@ -0,0 +1,176 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartReq + +**`Schema`** + +StorePostCartsCartReq +type: object +properties: + region_id: + type: string + description: "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency." + country_code: + type: string + description: "The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + email: + type: string + description: "An email to be used on the Cart." + format: email + sales_channel_id: + type: string + description: "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not + exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, + the specified sales channel must be within the scope of the publishable API key's resources." + billing_address: + description: "The Address to be used for billing purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + description: A full billing address object. + - type: string + description: The billing address ID + shipping_address: + description: "The Address to be used for shipping purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + description: A full shipping address object. + - type: string + description: The shipping address ID + gift_cards: + description: "An array of Gift Card codes to add to the Cart." + type: array + items: + type: object + required: + - code + properties: + code: + description: "The code of a gift card." + type: string + discounts: + description: "An array of Discount codes to add to the Cart." + type: array + items: + type: object + required: + - code + properties: + code: + description: "The code of the discount." + type: string + customer_id: + description: "The ID of the Customer to associate the Cart with." + type: string + context: + description: "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" + type: object + example: + ip: "::1" + user_agent: "Chrome" + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:136 + +___ + +### context + +• `Optional` **context**: `object` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:141 + +___ + +### country\_code + +• `Optional` **country\_code**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:134 + +___ + +### customer\_id + +• `Optional` **customer\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:140 + +___ + +### discounts + +• `Optional` **discounts**: [`Discount`](internal-8.Discount-2.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:139 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:135 + +___ + +### gift\_cards + +• `Optional` **gift\_cards**: [`GiftCard`](internal-8.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:138 + +___ + +### region\_id + +• `Optional` **region\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:133 + +___ + +### sales\_channel\_id + +• `Optional` **sales\_channel\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:142 + +___ + +### shipping\_address + +• `Optional` **shipping\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/update-cart.d.ts:137 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md new file mode 100644 index 0000000000..0b36348f5f --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCartsCartShippingMethodReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCartsCartShippingMethodReq + +**`Schema`** + +StorePostCartsCartShippingMethodReq +type: object +required: + - option_id +properties: + option_id: + type: string + description: ID of the shipping option to create the method from. + data: + type: object + description: Used to hold any data that the shipping method may need to process the fulfillment of the order. This depends on the fulfillment provider you're using. + +## Properties + +### data + +• `Optional` **data**: [`Record`](../modules/internal.md#record)<`string`, `any`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:72 + +___ + +### option\_id + +• **option\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/add-shipping-method.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md new file mode 100644 index 0000000000..22066adfb7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerAcceptClaimReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersCustomerAcceptClaimReq + +**`Schema`** + +StorePostCustomersCustomerAcceptClaimReq +type: object +required: + - token +properties: + token: + description: "The claim token generated by previous request to the Claim Order endpoint." + type: string + +## Properties + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/confirm-order-request.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md new file mode 100644 index 0000000000..199cbb5f32 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerOrderClaimReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersCustomerOrderClaimReq + +**`Schema`** + +StorePostCustomersCustomerOrderClaimReq +type: object +required: + - order_ids +properties: + order_ids: + description: "The ID of the orders to claim" + type: array + items: + type: string + +## Properties + +### order\_ids + +• **order\_ids**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/request-order.d.ts:80 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md new file mode 100644 index 0000000000..d01a5c1176 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md @@ -0,0 +1,29 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerPasswordTokenReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersCustomerPasswordTokenReq + +**`Schema`** + +StorePostCustomersCustomerPasswordTokenReq +type: object +required: + - email +properties: + email: + description: "The customer's email." + type: string + format: email + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/reset-password-token.d.ts:72 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md new file mode 100644 index 0000000000..bc8325683b --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersCustomerReq.md @@ -0,0 +1,111 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersCustomerReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersCustomerReq + +**`Schema`** + +StorePostCustomersCustomerReq +type: object +properties: + first_name: + description: "The customer's first name." + type: string + last_name: + description: "The customer's last name." + type: string + billing_address: + description: "The address to be used for billing purposes." + anyOf: + - $ref: "#/components/schemas/AddressPayload" + description: The full billing address object + - type: string + description: The ID of an existing billing address + password: + description: "The customer's password." + type: string + phone: + description: "The customer's phone number." + type: string + email: + description: "The customer's email." + type: string + metadata: + description: "Additional custom data about the customer." + type: object + externalDocs: + description: "Learn about the metadata attribute, and how to delete and update it." + url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" + +## Properties + +### billing\_address + +• `Optional` **billing\_address**: `string` \| [`AddressPayload`](internal.AddressPayload.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:98 + +___ + +### email + +• `Optional` **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:103 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:99 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:100 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:104 + +___ + +### password + +• `Optional` **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:101 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/update-customer.d.ts:102 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md new file mode 100644 index 0000000000..3c2bb70208 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersReq.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersReq + +**`Schema`** + +StorePostCustomersReq +type: object +required: + - first_name + - last_name + - email + - password +properties: + first_name: + description: "The customer's first name." + type: string + last_name: + description: "The customer's last name." + type: string + email: + description: "The customer's email." + type: string + format: email + password: + description: "The customer's password." + type: string + format: password + phone: + description: "The customer's phone number." + type: string + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:111 + +___ + +### first\_name + +• **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:109 + +___ + +### last\_name + +• **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:110 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:112 + +___ + +### phone + +• `Optional` **phone**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/create-customer.d.ts:113 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md new file mode 100644 index 0000000000..e3639f2947 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostCustomersResetPasswordReq.md @@ -0,0 +1,58 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostCustomersResetPasswordReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostCustomersResetPasswordReq + +**`Schema`** + +StorePostCustomersResetPasswordReq +type: object +required: + - email + - password + - token +properties: + email: + description: "The customer's email." + type: string + format: email + password: + description: "The customer's password." + type: string + format: password + token: + description: "The reset password token" + type: string + +## Properties + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/reset-password.d.ts:86 + +___ + +### password + +• **password**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/reset-password.d.ts:88 + +___ + +### token + +• **token**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/reset-password.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md new file mode 100644 index 0000000000..db7317d178 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md @@ -0,0 +1,26 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostOrderEditsOrderEditDecline + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostOrderEditsOrderEditDecline + +**`Schema`** + +StorePostOrderEditsOrderEditDecline +type: object +properties: + declined_reason: + type: string + description: The reason for declining the Order Edit. + +## Properties + +### declined\_reason + +• `Optional` **declined\_reason**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/order-edits/decline-order-edit.d.ts:59 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md new file mode 100644 index 0000000000..1c046640f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostPaymentCollectionsBatchSessionsAuthorizeReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostPaymentCollectionsBatchSessionsAuthorizeReq + +**`Schema`** + +StorePostPaymentCollectionsBatchSessionsAuthorizeReq +type: object +required: + - session_ids +properties: + session_ids: + description: "List of Payment Session IDs to authorize." + type: array + items: + type: string + +## Properties + +### session\_ids + +• **session\_ids**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/authorize-batch-payment-sessions.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md new file mode 100644 index 0000000000..da43d3cc6a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostPaymentCollectionsBatchSessionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostPaymentCollectionsBatchSessionsReq + +**`Schema`** + +StorePostPaymentCollectionsBatchSessionsReq +type: object +required: + - sessions +properties: + sessions: + description: "An array of payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted." + type: array + items: + type: object + required: + - provider_id + - amount + properties: + provider_id: + type: string + description: The ID of the Payment Provider. + amount: + type: integer + description: "The payment amount" + session_id: + type: string + description: "The ID of the Payment Session to be updated. If no ID is provided, a new payment session is created." + +## Properties + +### sessions + +• **sessions**: [`StorePostPaymentCollectionsSessionsReq`](internal-8.internal.StorePostPaymentCollectionsSessionsReq.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:131 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md new file mode 100644 index 0000000000..0103a02b98 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostPaymentCollectionsSessionsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostPaymentCollectionsSessionsReq + +## Properties + +### amount + +• **amount**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:102 + +___ + +### provider\_id + +• **provider\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:101 + +___ + +### session\_id + +• `Optional` **session\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/manage-batch-payment-sessions.d.ts:103 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md new file mode 100644 index 0000000000..41a0edef95 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostReturnsReq.md @@ -0,0 +1,79 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostReturnsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostReturnsReq + +**`Schema`** + +StorePostReturnsReq +type: object +required: + - order_id + - items +properties: + order_id: + type: string + description: The ID of the Order to create the return for. + items: + description: "The items to include in the return." + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the line item to return. + type: string + quantity: + description: The quantity to return. + type: integer + reason_id: + description: The ID of the return reason. Return reasons can be retrieved from the List Return Reasons endpoint. + type: string + note: + description: A note to add to the item returned. + type: string + return_shipping: + description: The return shipping method used to return the items. If provided, a fulfillment is automatically created for the return. + type: object + required: + - option_id + properties: + option_id: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + +## Properties + +### items + +• **items**: [`Item`](internal-8.Item-5.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:122 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:121 + +___ + +### return\_shipping + +• `Optional` **return\_shipping**: [`ReturnShipping`](internal-8.ReturnShipping-3.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/create-return.d.ts:123 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md new file mode 100644 index 0000000000..4c9aaa8a08 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSearchReq.md @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostSearchReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostSearchReq + +**`Schema`** + +StorePostSearchReq +type: object +properties: + q: + type: string + description: The search query. + offset: + type: number + description: The number of products to skip when retrieving the products. + limit: + type: number + description: Limit the number of products returned. + filter: + description: Pass filters based on the search service. + +## Properties + +### filter + +• `Optional` **filter**: `unknown` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:76 + +___ + +### limit + +• `Optional` **limit**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:75 + +___ + +### offset + +• `Optional` **offset**: `number` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:74 + +___ + +### q + +• `Optional` **q**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/products/search.d.ts:73 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md new file mode 100644 index 0000000000..afefae894d --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StorePostSwapsReq.md @@ -0,0 +1,99 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StorePostSwapsReq + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StorePostSwapsReq + +**`Schema`** + +StorePostSwapsReq +type: object +required: + - order_id + - return_items + - additional_items +properties: + order_id: + type: string + description: The ID of the Order to create the Swap for. + return_items: + description: "The items to include in the Return." + type: array + items: + type: object + required: + - item_id + - quantity + properties: + item_id: + description: The ID of the order's line item to return. + type: string + quantity: + description: The quantity to return. + type: integer + reason_id: + description: The ID of the reason of this return. Return reasons can be retrieved from the List Return Reasons endpoint. + type: string + note: + description: The note to add to the item being swapped. + type: string + return_shipping_option: + type: string + description: The ID of the Shipping Option to create the Shipping Method from. + additional_items: + description: "The items to exchange the returned items with." + type: array + items: + type: object + required: + - variant_id + - quantity + properties: + variant_id: + description: The ID of the Product Variant. + type: string + quantity: + description: The quantity of the variant. + type: integer + +## Properties + +### additional\_items + +• **additional\_items**: [`AdditionalItem`](internal-8.AdditionalItem-2.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:152 + +___ + +### order\_id + +• **order\_id**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:150 + +___ + +### return\_items + +• **return\_items**: [`Item`](internal-8.Item-6.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:151 + +___ + +### return\_shipping\_option + +• `Optional` **return\_shipping\_option**: `string` + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/create-swap.d.ts:153 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md new file mode 100644 index 0000000000..77a43b01ef --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StoreService.md @@ -0,0 +1,354 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StoreService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StoreService + +Provides layer to manipulate store settings. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`StoreService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### currencyRepository\_ + +• `Protected` `Readonly` **currencyRepository\_**: `Repository`<[`Currency`](internal-3.Currency.md)\> + +#### Defined in + +packages/medusa/dist/services/store.d.ts:20 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/store.d.ts:21 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### storeRepository\_ + +• `Protected` `Readonly` **storeRepository\_**: `Repository`<[`Store`](internal-8.internal.Store.md)\> + +#### Defined in + +packages/medusa/dist/services/store.d.ts:19 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addCurrency + +▸ **addCurrency**(`code`): `Promise`<[`Store`](internal-8.internal.Store.md)\> + +Add a currency to the store + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | 3 character ISO currency code | + +#### Returns + +`Promise`<[`Store`](internal-8.internal.Store.md)\> + +result after update + +#### Defined in + +packages/medusa/dist/services/store.d.ts:46 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(): `Promise`<[`Store`](internal-8.internal.Store.md)\> + +Creates a store if it doesn't already exist. + +#### Returns + +`Promise`<[`Store`](internal-8.internal.Store.md)\> + +The store. + +#### Defined in + +packages/medusa/dist/services/store.d.ts:27 + +___ + +### getDefaultCurrency\_ + +▸ `Protected` **getDefaultCurrency_**(`code`): [`Partial`](../modules/internal-8.md#partial)<[`Currency`](internal-3.Currency.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `code` | `string` | + +#### Returns + +[`Partial`](../modules/internal-8.md#partial)<[`Currency`](internal-3.Currency.md)\> + +#### Defined in + +packages/medusa/dist/services/store.d.ts:34 + +___ + +### removeCurrency + +▸ **removeCurrency**(`code`): `Promise`<`any`\> + +Removes a currency from the store + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `code` | `string` | 3 character ISO currency code | + +#### Returns + +`Promise`<`any`\> + +result after update + +#### Defined in + +packages/medusa/dist/services/store.d.ts:52 + +___ + +### retrieve + +▸ **retrieve**(`config?`): `Promise`<[`Store`](internal-8.internal.Store.md)\> + +Retrieve the store settings. There is always a maximum of one store. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Store`](internal-8.internal.Store.md)\> | The config object from which the query will be built | + +#### Returns + +`Promise`<[`Store`](internal-8.internal.Store.md)\> + +the store + +#### Defined in + +packages/medusa/dist/services/store.d.ts:33 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`data`): `Promise`<[`Store`](internal-8.internal.Store.md)\> + +Updates a store + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | [`UpdateStoreInput`](../modules/internal-8.md#updatestoreinput) | an object with the update values. | + +#### Returns + +`Promise`<[`Store`](internal-8.internal.Store.md)\> + +resolves to the update result. + +#### Defined in + +packages/medusa/dist/services/store.d.ts:40 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StoreService`](internal-8.internal.StoreService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`StoreService`](internal-8.internal.StoreService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md new file mode 100644 index 0000000000..bfc4f73055 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.StrategyResolverService.md @@ -0,0 +1,218 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: StrategyResolverService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).StrategyResolverService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`StrategyResolverService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### container + +• `Protected` `Readonly` **container**: [`InjectedDependencies`](../modules/internal-8.md#injecteddependencies-38) + +#### Defined in + +packages/medusa/dist/services/strategy-resolver.d.ts:8 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### resolveBatchJobByType + +▸ **resolveBatchJobByType**(`type`): [`AbstractBatchJobStrategy`](internal-8.internal.AbstractBatchJobStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `type` | `string` | + +#### Returns + +[`AbstractBatchJobStrategy`](internal-8.internal.AbstractBatchJobStrategy.md) + +#### Defined in + +packages/medusa/dist/services/strategy-resolver.d.ts:10 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`StrategyResolverService`](internal-8.internal.StrategyResolverService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`StrategyResolverService`](internal-8.internal.StrategyResolverService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md new file mode 100644 index 0000000000..31059c820a --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SwapService.md @@ -0,0 +1,779 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SwapService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SwapService + +Handles swaps + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`SwapService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cartService\_ + +• `Protected` `Readonly` **cartService\_**: [`CartService`](internal-8.internal.CartService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:40 + +___ + +### customShippingOptionService\_ + +• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:50 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:41 + +___ + +### fulfillmentService\_ + +• `Protected` `Readonly` **fulfillmentService\_**: [`FulfillmentService`](internal-8.FulfillmentService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:46 + +___ + +### lineItemAdjustmentService\_ + +• `Protected` `Readonly` **lineItemAdjustmentService\_**: [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:49 + +___ + +### lineItemService\_ + +• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](internal-8.internal.LineItemService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:45 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### orderService\_ + +• `Protected` `Readonly` **orderService\_**: [`OrderService`](internal-8.internal.OrderService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:42 + +___ + +### paymentProviderService\_ + +• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:48 + +___ + +### productVariantInventoryService\_ + +• `Protected` `Readonly` **productVariantInventoryService\_**: [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:51 + +___ + +### returnService\_ + +• `Protected` `Readonly` **returnService\_**: [`ReturnService`](internal-8.internal.ReturnService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:43 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:47 + +___ + +### swapRepository\_ + +• `Protected` `Readonly` **swapRepository\_**: `Repository`<[`Swap`](internal-3.Swap.md)\> + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:39 + +___ + +### totalsService\_ + +• `Protected` `Readonly` **totalsService\_**: [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:44 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `FULFILLMENT_CREATED` | `string` | +| `PAYMENT_CAPTURED` | `string` | +| `PAYMENT_CAPTURE_FAILED` | `string` | +| `PAYMENT_COMPLETED` | `string` | +| `PROCESS_REFUND_FAILED` | `string` | +| `RECEIVED` | `string` | +| `REFUND_PROCESSED` | `string` | +| `SHIPMENT_CREATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:28 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### areReturnItemsValid + +▸ `Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnItems` | [`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Partial`](../modules/internal-8.md#partial)<[`ReturnItem`](internal-3.ReturnItem.md)\>, ``"item_id"``\>[] | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:214 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### cancel + +▸ **cancel**(`swapId`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Cancels a given swap if possible. A swap can only be canceled if all +related returns, fulfillments, and payments have been canceled. If a swap +is associated with a refund, it cannot be canceled. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the id of the swap to cancel. | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the canceled swap. + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:169 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Cancels a fulfillment (if related to a swap) + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fulfillmentId` | `string` | the ID of the fulfillment to cancel | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +updated swap + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:185 + +___ + +### create + +▸ **create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Creates a swap from an order, with given return items, additional items +and an optional return shipping method. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to base the swap off | +| `returnItems` | [`WithRequiredProperty`](../modules/internal-8.internal.md#withrequiredproperty)<[`Partial`](../modules/internal-8.md#partial)<[`ReturnItem`](internal-3.ReturnItem.md)\>, ``"item_id"``\>[] | the items to return in the swap | +| `additionalItems?` | [`Pick`](../modules/internal-1.md#pick)<[`LineItem`](internal-3.LineItem.md), ``"variant_id"`` \| ``"quantity"``\>[] | the items to send to the customer | +| `returnShipping?` | `Object` | an optional shipping method for returning the returnItems | +| `returnShipping.option_id` | `string` | - | +| `returnShipping.price?` | `number` | - | +| `custom?` | `Object` | contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order | +| `custom.allow_backorder?` | `boolean` | - | +| `custom.idempotency_key?` | `string` | - | +| `custom.location_id?` | `string` | - | +| `custom.no_notification?` | `boolean` | - | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the newly created swap + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:114 + +___ + +### createCart + +▸ **createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Creates a cart from the given swap. The cart can be used to pay +for differences associated with the swap. The swap represented by the +swapId must belong to the order. Fails if there is already a cart on the +swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the id of the swap to create the cart from | +| `customShippingOptions?` | { `option_id`: `string` ; `price`: `number` }[] | the shipping options | +| `context?` | `Object` | - | +| `context.sales_channel_id?` | `string` | - | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the swap with its cart_id prop set to the id of the new cart. + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:148 + +___ + +### createFulfillment + +▸ **createFulfillment**(`swapId`, `config?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Fulfills the additional items associated with the swap. Will call the +fulfillment providers associated with the shipping methods. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the id of the swap to fulfill, | +| `config?` | [`CreateShipmentConfig`](../modules/internal-8.md#createshipmentconfig) | optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag. | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the updated swap with new status and fulfillments. + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:178 + +___ + +### createShipment + +▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Marks a fulfillment as shipped and attaches tracking numbers. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the id of the swap that has been shipped. | +| `fulfillmentId` | `string` | the id of the specific fulfillment that has been shipped | +| `trackingLinks?` | { `tracking_number`: `string` }[] | the tracking numbers associated with the shipment | +| `config?` | [`CreateShipmentConfig`](../modules/internal-8.md#createshipmentconfig) | optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag. | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the updated swap with new fulfillments and status. + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:195 + +___ + +### deleteMetadata + +▸ **deleteMetadata**(`swapId`, `key`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Dedicated method to delete metadata for a swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the order to delete metadata from. | +| `key` | `string` | key for metadata field | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +resolves to the updated result. + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:205 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`Swap`](internal-3.Swap.md)[]\> + +List swaps. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Swap`](internal-3.Swap.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:92 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Swap`](internal-3.Swap.md)[], `number`]\> + +List swaps. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`Selector`](../modules/internal-8.internal.md#selector)<[`Swap`](internal-3.Swap.md)\> | the query object for find | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\> | the configuration used to find the objects. contains relations, skip, and take. | + +#### Returns + +`Promise`<[[`Swap`](internal-3.Swap.md)[], `number`]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:100 + +___ + +### processDifference + +▸ **processDifference**(`swapId`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Process difference for the requested swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | id of a swap being processed | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +processed swap + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:129 + +___ + +### registerCartCompletion + +▸ **registerCartCompletion**(`swapId`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Register a cart completion + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | The id of the swap | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +swap related to the cart + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:160 + +___ + +### registerReceived + +▸ **registerReceived**(`id`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Registers the swap return items as received so that they cannot be used +as a part of other swaps/returns. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `any` | the id of the order with the swap. | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the resulting order + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:213 + +___ + +### retrieve + +▸ **retrieve**(`swapId`, `config?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Retrieves a swap with the given id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | the id of the swap to retrieve | +| `config?` | [`Omit`](../modules/internal-1.md#omit)<[`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\>, ``"select"``\> & { `select?`: `string`[] } | the configuration to retrieve the swap | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the swap + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:74 + +___ + +### retrieveByCartId + +▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Retrieves a swap based on its associated cart id + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the cart id that the swap's cart has | +| `relations?` | `string`[] | the relations to retrieve swap | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +the swap + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:84 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### transformQueryForCart + +▸ `Protected` **transformQueryForCart**(`config`): [`Omit`](../modules/internal-1.md#omit)<[`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](internal-3.Cart.md)[] } + +Transform find config object for retrieval. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `config` | [`Omit`](../modules/internal-1.md#omit)<[`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\>, ``"select"``\> & { `select?`: `string`[] } | parsed swap find config | + +#### Returns + +[`Omit`](../modules/internal-1.md#omit)<[`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](internal-3.Swap.md)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](internal-3.Cart.md)[] } + +transformed find swap config + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:59 + +___ + +### update + +▸ **update**(`swapId`, `update`): `Promise`<[`Swap`](internal-3.Swap.md)\> + +Update the swap record. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `swapId` | `string` | id of a swap to update | +| `update` | [`Partial`](../modules/internal-8.md#partial)<[`Swap`](internal-3.Swap.md)\> | new data | + +#### Returns + +`Promise`<[`Swap`](internal-3.Swap.md)\> + +updated swap record + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:137 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SwapService`](internal-8.internal.SwapService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SwapService`](internal-8.internal.SwapService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md new file mode 100644 index 0000000000..9d3216e0aa --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.SystemPaymentProviderService.md @@ -0,0 +1,398 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: SystemPaymentProviderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).SystemPaymentProviderService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`SystemPaymentProviderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### identifier + +▪ `Static` **identifier**: `string` + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:3 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePayment + +▸ **authorizePayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:8 + +___ + +### cancelPayment + +▸ **cancelPayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:14 + +___ + +### capturePayment + +▸ **capturePayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:12 + +___ + +### createPayment + +▸ **createPayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:5 + +___ + +### deletePayment + +▸ **deletePayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:11 + +___ + +### getPaymentData + +▸ **getPaymentData**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:7 + +___ + +### getStatus + +▸ **getStatus**(`_`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:6 + +___ + +### refundPayment + +▸ **refundPayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:13 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### updatePayment + +▸ **updatePayment**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:10 + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`_`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `_` | `any` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/services/system-payment-provider.d.ts:9 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](internal-8.internal.SystemPaymentProviderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`SystemPaymentProviderService`](internal-8.internal.SystemPaymentProviderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md new file mode 100644 index 0000000000..04f44c9274 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxProviderService.md @@ -0,0 +1,560 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxProviderService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).TaxProviderService + +Finds tax providers and assists in tax related operations. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`TaxProviderService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### cacheService\_ + +• `Protected` `Readonly` **cacheService\_**: [`ICacheService`](../interfaces/internal-8.ICacheService.md) + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:19 + +___ + +### container\_ + +• `Protected` `Readonly` **container\_**: `AwilixContainer`<`any`\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:18 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:24 + +___ + +### getCacheKey + +• `Private` **getCacheKey**: `any` + +The cache key to get cache hits by. + +**`Param`** + +the entity id to cache + +**`Param`** + +the region id to cache + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:99 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### smTaxLineRepo\_ + +• `Protected` `Readonly` **smTaxLineRepo\_**: `Repository`<[`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: [`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[]) => `Promise`<[`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:22 + +___ + +### taxLineRepo\_ + +• `Protected` `Readonly` **taxLineRepo\_**: `Repository`<[`LineItemTaxLine`](internal-3.LineItemTaxLine.md)\> & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: [`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[]) => `Promise`<[`LineItemTaxLine`](internal-3.LineItemTaxLine.md)[]\> } + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:21 + +___ + +### taxProviderRepo\_ + +• `Protected` `Readonly` **taxProviderRepo\_**: `Repository`<[`TaxProvider`](internal-3.TaxProvider.md)\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:23 + +___ + +### taxRateService\_ + +• `Protected` `Readonly` **taxRateService\_**: [`TaxRateService`](internal-8.internal.TaxRateService.md) + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:20 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### clearLineItemsTaxLines + +▸ **clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `itemIds` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:33 + +___ + +### clearTaxLines + +▸ **clearTaxLines**(`cartId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:34 + +___ + +### createShippingTaxLines + +▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +Persists the tax lines relevant for a shipping method to the database. Used +for return shipping methods. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingMethod` | [`ShippingMethod`](internal-3.ShippingMethod.md) | the shipping method to create tax lines for | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | the calculation context to get tax lines by | + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +the newly created tax lines + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:49 + +___ + +### createTaxLines + +▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +Persists the tax lines relevant for an order to the database. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrLineItems` | [`Cart`](internal-3.Cart.md) \| [`LineItem`](internal-3.LineItem.md)[] | the cart or line items to create tax lines for | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | the calculation context to get tax lines by | + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +the newly created tax lines + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:41 + +___ + +### getRegionRatesForProduct + +▸ **getRegionRatesForProduct**(`productIds`, `region`): `Promise`<`Map`<`string`, [`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[]\>\> + +Gets the tax rates configured for a product. The rates are cached between +calls. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `productIds` | `string` \| `string`[] | | +| `region` | [`RegionDetails`](../modules/internal-8.md#regiondetails) | the region to get configured rates for. | + +#### Returns + +`Promise`<`Map`<`string`, [`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[]\>\> + +the tax rates configured for the shipping option. A map by product id + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:92 + +___ + +### getRegionRatesForShipping + +▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<[`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[]\> + +Gets the tax rates configured for a shipping option. The rates are cached +between calls. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `optionId` | `string` | the option id of the shipping method. | +| `regionDetails` | [`RegionDetails`](../modules/internal-8.md#regiondetails) | the region to get configured rates for. | + +#### Returns + +`Promise`<[`TaxServiceRate`](../modules/internal-8.md#taxservicerate)[]\> + +the tax rates configured for the shipping option. + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:84 + +___ + +### getShippingTaxLines + +▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<[`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[]\> + +Gets the relevant tax lines for a shipping method. Note: this method +doesn't persist the tax lines. Use createShippingTaxLines if you wish to +persist the tax lines to the DB layer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingMethod` | [`ShippingMethod`](internal-3.ShippingMethod.md) | the shipping method to get tax lines for | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | the calculation context to get tax lines by | + +#### Returns + +`Promise`<[`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md)[]\> + +the computed tax lines + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:58 + +___ + +### getTaxLines + +▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +Gets the relevant tax lines for an order or cart. If an order is provided +the order's tax lines will be returned. If a cart is provided the tax lines +will be computed from the tax rules and potentially a 3rd party tax plugin. +Note: this method doesn't persist the tax lines. Use createTaxLines if you +wish to persist the tax lines to the DB layer. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItems` | [`LineItem`](internal-3.LineItem.md)[] | the cart or order to get tax lines for | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | the calculation context to get tax lines by | + +#### Returns + +`Promise`<([`ShippingMethodTaxLine`](internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](internal-3.LineItemTaxLine.md))[]\> + +the computed tax lines + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:69 + +___ + +### getTaxLinesMap + +▸ `Protected` **getTaxLinesMap**(`items`, `calculationContext`): `Promise`<[`TaxLinesMaps`](../modules/internal-8.md#taxlinesmaps)\> + +Return a map of tax lines for line items and shipping methods + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `items` | [`LineItem`](internal-3.LineItem.md)[] | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | + +#### Returns + +`Promise`<[`TaxLinesMaps`](../modules/internal-8.md#taxlinesmaps)\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:76 + +___ + +### list + +▸ **list**(): `Promise`<[`TaxProvider`](internal-3.TaxProvider.md)[]\> + +#### Returns + +`Promise`<[`TaxProvider`](internal-3.TaxProvider.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:26 + +___ + +### registerInstalledProviders + +▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `providers` | `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:100 + +___ + +### retrieveProvider + +▸ **retrieveProvider**(`region`): [`ITaxService`](../interfaces/internal-8.internal.ITaxService.md) + +Retrieves the relevant tax provider for the given region. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `region` | [`Region`](internal-3.Region.md) | the region to get tax provider for. | + +#### Returns + +[`ITaxService`](../interfaces/internal-8.internal.ITaxService.md) + +the region specific tax provider + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:32 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md new file mode 100644 index 0000000000..c57615b06c --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TaxRateService.md @@ -0,0 +1,522 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TaxRateService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).TaxRateService + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`TaxRateService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### productService\_ + +• `Protected` `Readonly` **productService\_**: [`ProductService`](internal-8.internal.ProductService.md) + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:10 + +___ + +### productTypeService\_ + +• `Protected` `Readonly` **productTypeService\_**: [`ProductTypeService`](internal-8.internal.ProductTypeService.md) + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:11 + +___ + +### shippingOptionService\_ + +• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:12 + +___ + +### taxRateRepository\_ + +• `Protected` `Readonly` **taxRateRepository\_**: `Repository`<[`TaxRate`](internal-3.TaxRate.md)\> & { `addToProduct`: (`id`: `string`, `productIds`: `string`[], `overrideExisting?`: `boolean`) => `Promise`<[`ProductTaxRate`](internal-8.internal.ProductTaxRate.md)[]\> ; `addToProductType`: (`id`: `string`, `productTypeIds`: `string`[], `overrideExisting?`: `boolean`) => `Promise`<[`ProductTypeTaxRate`](internal-8.internal.ProductTypeTaxRate.md)[]\> ; `addToShippingOption`: (`id`: `string`, `optionIds`: `string`[], `overrideExisting?`: `boolean`) => `Promise`<[`ShippingTaxRate`](internal-8.internal.ShippingTaxRate.md)[]\> ; `applyResolutionsToQueryBuilder`: (`qb`: `SelectQueryBuilder`<[`TaxRate`](internal-3.TaxRate.md)\>, `resolverFields`: `string`[]) => `SelectQueryBuilder`<[`TaxRate`](internal-3.TaxRate.md)\> ; `findAndCountWithResolution`: (`findOptions`: `FindManyOptions`<[`TaxRate`](internal-3.TaxRate.md)\>) => `Promise`<[[`TaxRate`](internal-3.TaxRate.md)[], `number`]\> ; `findOneWithResolution`: (`findOptions`: `FindManyOptions`<[`TaxRate`](internal-3.TaxRate.md)\>) => `Promise`<``null`` \| [`TaxRate`](internal-3.TaxRate.md)\> ; `findWithResolution`: (`findOptions`: `FindManyOptions`<[`TaxRate`](internal-3.TaxRate.md)\>) => `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> ; `getFindQueryBuilder`: (`findOptions`: `FindManyOptions`<[`TaxRate`](internal-3.TaxRate.md)\>) => `SelectQueryBuilder`<[`TaxRate`](internal-3.TaxRate.md)\> ; `listByProduct`: (`productId`: `string`, `config`: [`TaxRateListByConfig`](../modules/internal-8.md#taxratelistbyconfig)) => `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> ; `listByShippingOption`: (`optionId`: `string`) => `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> ; `removeFromProduct`: (`id`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> ; `removeFromProductType`: (`id`: `string`, `productTypeIds`: `string`[]) => `Promise`<`DeleteResult`\> ; `removeFromShippingOption`: (`id`: `string`, `optionIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:13 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### addToProduct + +▸ **addToProduct**(`id`, `productIds`, `replace?`): `Promise`<[`ProductTaxRate`](internal-8.internal.ProductTaxRate.md) \| [`ProductTaxRate`](internal-8.internal.ProductTaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `productIds` | `string` \| `string`[] | +| `replace?` | `boolean` | + +#### Returns + +`Promise`<[`ProductTaxRate`](internal-8.internal.ProductTaxRate.md) \| [`ProductTaxRate`](internal-8.internal.ProductTaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:29 + +___ + +### addToProductType + +▸ **addToProductType**(`id`, `productTypeIds`, `replace?`): `Promise`<[`ProductTypeTaxRate`](internal-8.internal.ProductTypeTaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `productTypeIds` | `string` \| `string`[] | +| `replace?` | `boolean` | + +#### Returns + +`Promise`<[`ProductTypeTaxRate`](internal-8.internal.ProductTypeTaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:30 + +___ + +### addToShippingOption + +▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<[`ShippingTaxRate`](internal-8.internal.ShippingTaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `optionIds` | `string` \| `string`[] | +| `replace?` | `boolean` | + +#### Returns + +`Promise`<[`ShippingTaxRate`](internal-8.internal.ShippingTaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:31 + +___ + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`data`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateTaxRateInput`](../modules/internal-8.md#createtaxrateinput) | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:23 + +___ + +### delete + +▸ **delete**(`id`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:25 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableTaxRateProps`](../modules/internal-8.md#filterabletaxrateprops) | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`TaxRate`](internal-3.TaxRate.md)\> | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:20 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`TaxRate`](internal-3.TaxRate.md)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableTaxRateProps`](../modules/internal-8.md#filterabletaxrateprops) | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`TaxRate`](internal-3.TaxRate.md)\> | + +#### Returns + +`Promise`<[[`TaxRate`](internal-3.TaxRate.md)[], `number`]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:21 + +___ + +### listByProduct + +▸ **listByProduct**(`productId`, `config`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productId` | `string` | +| `config` | [`TaxRateListByConfig`](../modules/internal-8.md#taxratelistbyconfig) | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:32 + +___ + +### listByShippingOption + +▸ **listByShippingOption**(`shippingOptionId`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `shippingOptionId` | `string` | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)[]\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:33 + +___ + +### removeFromProduct + +▸ **removeFromProduct**(`id`, `productIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `productIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:26 + +___ + +### removeFromProductType + +▸ **removeFromProductType**(`id`, `typeIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `typeIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:27 + +___ + +### removeFromShippingOption + +▸ **removeFromShippingOption**(`id`, `optionIds`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `optionIds` | `string` \| `string`[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:28 + +___ + +### retrieve + +▸ **retrieve**(`taxRateId`, `config?`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `taxRateId` | `string` | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`TaxRate`](internal-3.TaxRate.md)\> | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:22 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`id`, `data`): `Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `data` | [`UpdateTaxRateInput`](../modules/internal-8.md#updatetaxrateinput) | + +#### Returns + +`Promise`<[`TaxRate`](internal-3.TaxRate.md)\> + +#### Defined in + +packages/medusa/dist/services/tax-rate.d.ts:24 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](internal-8.internal.TaxRateService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`TaxRateService`](internal-8.internal.TaxRateService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md new file mode 100644 index 0000000000..708e0eabd8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TokenService.md @@ -0,0 +1,69 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TokenService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).TokenService + +## Properties + +### configModule\_ + +• `Protected` `Readonly` **configModule\_**: [`ConfigModule`](../modules/internal-8.md#configmodule) + +#### Defined in + +packages/medusa/dist/services/token.d.ts:9 + +___ + +### RESOLUTION\_KEY + +▪ `Static` **RESOLUTION\_KEY**: `string` + +#### Defined in + +packages/medusa/dist/services/token.d.ts:8 + +## Methods + +### signToken + +▸ **signToken**(`data`, `options?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `string` \| `object` \| [`Buffer`](../modules/internal-8.md#buffer) | +| `options?` | `SignOptions` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/services/token.d.ts:12 + +___ + +### verifyToken + +▸ **verifyToken**(`token`, `options?`): `string` \| `Jwt` \| `JwtPayload` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `token` | `string` | +| `options?` | `VerifyOptions` | + +#### Returns + +`string` \| `Jwt` \| `JwtPayload` + +#### Defined in + +packages/medusa/dist/services/token.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md new file mode 100644 index 0000000000..2abfea9784 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TotalsService.md @@ -0,0 +1,826 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TotalsService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).TotalsService + +A service that calculates total and subtotals for orders, carts etc.. + +**`Implements`** + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`TotalsService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:72 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### newTotalsService\_ + +• `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:70 + +___ + +### taxCalculationStrategy\_ + +• `Protected` `Readonly` **taxCalculationStrategy\_**: [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:71 + +___ + +### taxProviderService\_ + +• `Protected` `Readonly` **taxProviderService\_**: [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:69 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### calculateDiscount\_ + +▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): [`LineDiscount`](../modules/internal-8.md#linediscount) + +Calculates either fixed or percentage discount of a variant + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | id of line item | +| `variant` | `string` | id of variant in line item | +| `variantPrice` | `number` | price of the variant based on region | +| `value` | `number` | discount value | +| `discountType` | [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) | the type of discount (fixed or percentage) | + +#### Returns + +[`LineDiscount`](../modules/internal-8.md#linediscount) + +triples of lineitem, variant and applied discount + +**`Deprecated`** + +- in favour of DiscountService.calculateDiscountForLineItem + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:171 + +___ + +### getAllocationItemDiscounts + +▸ **getAllocationItemDiscounts**(`discount`, `cart`): [`LineDiscount`](../modules/internal-8.md#linediscount)[] + +If the rule of a discount has allocation="item", then we need +to calculate discount on each item in the cart. Furthermore, we need to +make sure to only apply the discount on valid variants. And finally we +return ether an array of percentages discounts or fixed discounts +alongside the variant on which the discount was applied. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `discount` | [`Discount`](internal-3.Discount.md) | the discount to which we do the calculation | +| `cart` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart to calculate discounts for | + +#### Returns + +[`LineDiscount`](../modules/internal-8.md#linediscount)[] + +array of triples of lineitem, variant and applied discount + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:182 + +___ + +### getAllocationMap + +▸ **getAllocationMap**(`orderOrCart`, `options?`): `Promise`<[`LineAllocationsMap`](../modules/internal-8.md#lineallocationsmap)\> + +Gets a map of discounts and gift cards that apply to line items in an +order. The function calculates the amount of a discount or gift card that +applies to a specific line item. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `orderOrCart` | `Object` | the order or cart to get an allocation map for | +| `orderOrCart.claims?` | [`ClaimOrder`](internal-3.ClaimOrder.md)[] | - | +| `orderOrCart.discounts?` | [`Discount`](internal-3.Discount.md)[] | - | +| `orderOrCart.items` | [`LineItem`](internal-3.LineItem.md)[] | - | +| `orderOrCart.swaps?` | [`Swap`](internal-3.Swap.md)[] | - | +| `options?` | [`AllocationMapOptions`](../modules/internal-8.md#allocationmapoptions) | controls what should be included in allocation map | + +#### Returns + +`Promise`<[`LineAllocationsMap`](../modules/internal-8.md#lineallocationsmap)\> + +the allocation map for the line items in the cart or order. + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:133 + +___ + +### getCalculationContext + +▸ **getCalculationContext**(`calculationContextData`, `options?`): `Promise`<[`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext)\> + +Prepares the calculation context for a tax total calculation. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `calculationContextData` | [`CalculationContextData`](../modules/internal-8.md#calculationcontextdata) | the calculationContextData to get the calculation context for | +| `options?` | [`CalculationContextOptions`](../modules/internal-8.md#calculationcontextoptions) | options to gather context by | + +#### Returns + +`Promise`<[`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext)\> + +the tax calculation context + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:247 + +___ + +### getDiscountTotal + +▸ **getDiscountTotal**(`cartOrOrder`): `Promise`<`number`\> + +Calculates the total discount amount for each of the different supported +discount types. If discounts aren't present or invalid returns 0. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to calculate discounts for | + +#### Returns + +`Promise`<`number`\> + +the total discounts amount + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:240 + +___ + +### getGiftCardTotal + +▸ **getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +Gets the gift card amount on a cart or order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to get gift card amount for | +| `opts?` | `Object` | - | +| `opts.gift_cardable?` | `number` | - | + +#### Returns + +`Promise`<{ `tax_total`: `number` ; `total`: `number` }\> + +the gift card amount applied to the cart or order + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:228 + +___ + +### getGiftCardableAmount + +▸ **getGiftCardableAmount**(`cartOrOrder`): `Promise`<`number`\> + +Gets the amount that can be gift carded on a cart. In regions where gift +cards are taxable this amount should exclude taxes. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to get gift card amount for | + +#### Returns + +`Promise`<`number`\> + +the gift card amount applied to the cart or order + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:222 + +___ + +### getLineDiscounts + +▸ **getLineDiscounts**(`cartOrOrder`, `discount?`): [`LineDiscountAmount`](../modules/internal-8.md#linediscountamount)[] + +Returns the discount amount allocated to the line items of an order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | `Object` | the cart or order to get line discount allocations for | +| `cartOrOrder.claims?` | [`ClaimOrder`](internal-3.ClaimOrder.md)[] | - | +| `cartOrOrder.items` | [`LineItem`](internal-3.LineItem.md)[] | - | +| `cartOrOrder.swaps?` | [`Swap`](internal-3.Swap.md)[] | - | +| `discount?` | [`Discount`](internal-3.Discount.md) | the discount to use as context for the calculation | + +#### Returns + +[`LineDiscountAmount`](../modules/internal-8.md#linediscountamount)[] + +the allocations that the discount has on the items in the cart or + order + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:192 + +___ + +### getLineItemAdjustmentsTotal + +▸ **getLineItemAdjustmentsTotal**(`cartOrOrder`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | + +#### Returns + +`number` + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:184 + +___ + +### getLineItemDiscountAdjustment + +▸ **getLineItemDiscountAdjustment**(`lineItem`, `discount`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | +| `discount` | [`Discount`](internal-3.Discount.md) | + +#### Returns + +`number` + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:183 + +___ + +### getLineItemRefund + +▸ **getLineItemRefund**(`order`, `lineItem`): `Promise`<`number`\> + +The amount that can be refunded for a given line item. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | order to use as context for the calculation | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | the line item to calculate the refund amount for. | + +#### Returns + +`Promise`<`number`\> + +the line item refund amount. + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:151 + +___ + +### getLineItemTotal + +▸ **getLineItemTotal**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`number`\> + +Gets a total for a line item. The total can take gift cards, discounts and +taxes into account. This can be controlled through the options. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | the line item to calculate a total for | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to use as context for the calculation | +| `options?` | [`GetLineItemTotalOptions`](../modules/internal-8.md#getlineitemtotaloptions) | the options to use for the calculation | + +#### Returns + +`Promise`<`number`\> + +the line item total + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:215 + +___ + +### getLineItemTotals + +▸ **getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals-1)\> + +Breaks down the totals related to a line item; these are the subtotal, the +amount of discount applied to the line item, the amount of a gift card +applied to a line item and the amount of tax applied to a line item. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `lineItem` | [`LineItem`](internal-3.LineItem.md) | the line item to calculate totals for | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to use as context for the calculation | +| `options?` | [`LineItemTotalsOptions`](../modules/internal-8.md#lineitemtotalsoptions) | the options to evaluate the line item totals for | + +#### Returns + +`Promise`<[`LineItemTotals`](../modules/internal-8.md#lineitemtotals-1)\> + +the breakdown of the line item totals + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:206 + +___ + +### getPaidTotal + +▸ **getPaidTotal**(`order`): `number` + +Gets the total payments made on an order + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to calculate paid amount for | + +#### Returns + +`number` + +the total paid amount + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:86 + +___ + +### getRefundTotal + +▸ **getRefundTotal**(`order`, `lineItems`): `Promise`<`number`\> + +Calculates refund total of line items. +If any of the items to return have been discounted, we need to +apply the discount again before refunding them. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | cart or order to calculate subtotal for | +| `lineItems` | [`LineItem`](internal-3.LineItem.md)[] | the line items to calculate refund total for | + +#### Returns + +`Promise`<`number`\> + +the calculated subtotal + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:160 + +___ + +### getRefundedTotal + +▸ **getRefundedTotal**(`order`): `number` + +Gets the total refund amount for an order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to get total refund amount for. | + +#### Returns + +`number` + +the total refunded amount for an order. + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:144 + +___ + +### getShippingMethodTotals + +▸ **getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals-1)\> + +Gets the totals breakdown for a shipping method. Fetches tax lines if not +already provided. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `shippingMethod` | [`ShippingMethod`](internal-3.ShippingMethod.md) | the shipping method to get totals breakdown for. | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | the cart or order to use as context for the breakdown | +| `opts?` | [`GetShippingMethodTotalsOptions`](../modules/internal-8.md#getshippingmethodtotalsoptions) | options for what should be included | + +#### Returns + +`Promise`<[`ShippingMethodTotals`](../modules/internal-8.md#shippingmethodtotals-1)\> + +An object that breaks down the totals for the shipping method + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:102 + +___ + +### getShippingTotal + +▸ **getShippingTotal**(`cartOrOrder`): `Promise`<`number`\> + +Calculates shipping total + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | cart or order to calculate subtotal for | + +#### Returns + +`Promise`<`number`\> + +shipping total + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:115 + +___ + +### getSubtotal + +▸ **getSubtotal**(`cartOrOrder`, `opts?`): `Promise`<`number`\> + +Calculates subtotal of a given cart or order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | cart or order to calculate subtotal for | +| `opts?` | [`SubtotalOptions`](../modules/internal-8.md#subtotaloptions) | options | + +#### Returns + +`Promise`<`number`\> + +the calculated subtotal + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:109 + +___ + +### getSwapTotal + +▸ **getSwapTotal**(`order`): `number` + +The total paid for swaps. May be negative in case of negative swap +difference. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `order` | [`Order`](internal-3.Order.md) | the order to calculate swap total for | + +#### Returns + +`number` + +the swap total + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:93 + +___ + +### getTaxTotal + +▸ **getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\> + +Calculates tax total +Currently based on the Danish tax system + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | cart or order to calculate tax total for | +| `forceTaxes?` | `boolean` | whether taxes should be calculated regardless of region settings | + +#### Returns + +`Promise`<``null`` \| `number`\> + +tax total + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:124 + +___ + +### getTotal + +▸ **getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\> + +Calculates total of a given cart or order. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartOrOrder` | [`Order`](internal-3.Order.md) \| [`Cart`](internal-3.Cart.md) | object to calculate total for | +| `options?` | [`GetTotalsOptions`](../modules/internal-8.md#gettotalsoptions) | options to calculate by | + +#### Returns + +`Promise`<`number`\> + +the calculated subtotal + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:80 + +___ + +### rounded + +▸ **rounded**(`value`): `number` + +Rounds a number using Math.round. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | the value to round | + +#### Returns + +`number` + +the rounded value + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:253 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TotalsService`](internal-8.internal.TotalsService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`TotalsService`](internal-8.internal.TotalsService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md new file mode 100644 index 0000000000..3faa95e953 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.TransactionBaseService.md @@ -0,0 +1,280 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: TransactionBaseService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).TransactionBaseService + +## Hierarchy + +- **`TransactionBaseService`** + + ↳ [`IBatchJobStrategy`](../interfaces/internal-8.internal.IBatchJobStrategy.md) + + ↳ [`AbstractBatchJobStrategy`](internal-8.internal.AbstractBatchJobStrategy.md) + + ↳ [`AbstractCartCompletionStrategy`](internal-8.internal.AbstractCartCompletionStrategy.md) + + ↳ [`IFileService`](../interfaces/internal-8.internal.IFileService.md) + + ↳ [`AbstractFileService`](internal-8.internal.AbstractFileService.md) + + ↳ [`INotificationService`](../interfaces/internal-8.internal.INotificationService.md) + + ↳ [`AbstractNotificationService`](internal-8.internal.AbstractNotificationService.md) + + ↳ [`PaymentService`](../interfaces/internal-8.internal.PaymentService.md) + + ↳ [`AbstractPaymentService`](internal-8.internal.AbstractPaymentService.md) + + ↳ [`AbstractPriceSelectionStrategy`](internal-8.internal.AbstractPriceSelectionStrategy.md) + + ↳ [`AnalyticsConfigService`](internal-8.internal.AnalyticsConfigService.md) + + ↳ [`AuthService`](internal-8.internal.AuthService.md) + + ↳ [`BatchJobService`](internal-8.internal.BatchJobService.md) + + ↳ [`CartService`](internal-8.internal.CartService.md) + + ↳ [`ClaimService`](internal-8.internal.ClaimService.md) + + ↳ [`ClaimItemService`](internal-8.internal.ClaimItemService.md) + + ↳ [`CurrencyService`](internal-8.internal.CurrencyService.md) + + ↳ [`CustomShippingOptionService`](internal-8.internal.CustomShippingOptionService.md) + + ↳ [`CustomerService`](internal-8.internal.CustomerService.md) + + ↳ [`CustomerGroupService`](internal-8.internal.CustomerGroupService.md) + + ↳ [`DiscountService`](internal-8.internal.DiscountService.md) + + ↳ [`DiscountConditionService`](internal-8.internal.DiscountConditionService.md) + + ↳ [`DraftOrderService`](internal-8.internal.DraftOrderService.md) + + ↳ [`EventBusService`](internal-8.internal.EventBusService.md) + + ↳ [`FulfillmentProviderService`](internal-8.internal.FulfillmentProviderService.md) + + ↳ [`GiftCardService`](internal-8.internal.GiftCardService.md) + + ↳ [`IdempotencyKeyService`](internal-8.internal.IdempotencyKeyService.md) + + ↳ [`LineItemService`](internal-8.internal.LineItemService.md) + + ↳ [`LineItemAdjustmentService`](internal-8.internal.LineItemAdjustmentService.md) + + ↳ [`NewTotalsService`](internal-8.internal.NewTotalsService.md) + + ↳ [`NoteService`](internal-8.internal.NoteService.md) + + ↳ [`NotificationService`](internal-8.internal.NotificationService.md) + + ↳ [`OauthService`](internal-8.internal.OauthService.md) + + ↳ [`OrderService`](internal-8.internal.OrderService.md) + + ↳ [`OrderEditService`](internal-8.internal.OrderEditService.md) + + ↳ [`OrderEditItemChangeService`](internal-8.internal.OrderEditItemChangeService.md) + + ↳ [`PaymentCollectionService`](internal-8.internal.PaymentCollectionService.md) + + ↳ [`PaymentProviderService`](internal-8.internal.PaymentProviderService.md) + + ↳ [`PriceListService`](internal-8.internal.PriceListService.md) + + ↳ [`PricingService`](internal-8.internal.PricingService.md) + + ↳ [`ProductService`](internal-8.internal.ProductService.md) + + ↳ [`ProductCategoryService`](internal-8.internal.ProductCategoryService.md) + + ↳ [`ProductCollectionService`](internal-8.internal.ProductCollectionService.md) + + ↳ [`ProductTypeService`](internal-8.internal.ProductTypeService.md) + + ↳ [`ProductVariantService`](internal-8.internal.ProductVariantService.md) + + ↳ [`ProductVariantInventoryService`](internal-8.internal.ProductVariantInventoryService.md) + + ↳ [`RegionService`](internal-8.internal.RegionService.md) + + ↳ [`ReturnService`](internal-8.internal.ReturnService.md) + + ↳ [`ReturnReasonService`](internal-8.internal.ReturnReasonService.md) + + ↳ [`SalesChannelService`](internal-8.internal.SalesChannelService.md) + + ↳ [`SalesChannelInventoryService`](internal-8.internal.SalesChannelInventoryService.md) + + ↳ [`SalesChannelLocationService`](internal-8.internal.SalesChannelLocationService.md) + + ↳ [`ShippingOptionService`](internal-8.internal.ShippingOptionService.md) + + ↳ [`ShippingProfileService`](internal-8.internal.ShippingProfileService.md) + + ↳ [`StagedJobService`](internal-8.internal.StagedJobService.md) + + ↳ [`StoreService`](internal-8.internal.StoreService.md) + + ↳ [`StrategyResolverService`](internal-8.internal.StrategyResolverService.md) + + ↳ [`SwapService`](internal-8.internal.SwapService.md) + + ↳ [`SystemPaymentProviderService`](internal-8.internal.SystemPaymentProviderService.md) + + ↳ [`TaxProviderService`](internal-8.internal.TaxProviderService.md) + + ↳ [`TaxRateService`](internal-8.internal.TaxRateService.md) + + ↳ [`TotalsService`](internal-8.internal.TotalsService.md) + + ↳ [`UserService`](internal-8.internal.UserService.md) + + ↳ [`FulfillmentService`](internal-8.FulfillmentService.md) + + ↳ [`PaymentService`](internal-8.PaymentService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-8.internal.UserService.md b/www/apps/docs/content/references/js-client/classes/internal-8.internal.UserService.md new file mode 100644 index 0000000000..cd4e584f62 --- /dev/null +++ b/www/apps/docs/content/references/js-client/classes/internal-8.internal.UserService.md @@ -0,0 +1,504 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Class: UserService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).UserService + +Provides layer to manipulate users. + +## Hierarchy + +- [`TransactionBaseService`](internal-8.internal.TransactionBaseService.md) + + ↳ **`UserService`** + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__configModule__](internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__container__](internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### analyticsConfigService\_ + +• `Protected` `Readonly` **analyticsConfigService\_**: [`AnalyticsConfigService`](internal-8.internal.AnalyticsConfigService.md) + +#### Defined in + +packages/medusa/dist/services/user.d.ts:27 + +___ + +### eventBus\_ + +• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](internal-8.internal.EventBusService.md) + +#### Defined in + +packages/medusa/dist/services/user.d.ts:29 + +___ + +### featureFlagRouter\_ + +• `Protected` `Readonly` **featureFlagRouter\_**: [`FlagRouter`](internal-8.FlagRouter.md) + +#### Defined in + +packages/medusa/dist/services/user.d.ts:30 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[manager_](internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[transactionManager_](internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +___ + +### userRepository\_ + +• `Protected` `Readonly` **userRepository\_**: `Repository`<[`User`](internal-1.User.md)\> + +#### Defined in + +packages/medusa/dist/services/user.d.ts:28 + +___ + +### Events + +▪ `Static` **Events**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `CREATED` | `string` | +| `DELETED` | `string` | +| `PASSWORD_RESET` | `string` | +| `UPDATED` | `string` | + +#### Defined in + +packages/medusa/dist/services/user.d.ts:21 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[atomicPhase_](internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### create + +▸ **create**(`user`, `password`): `Promise`<[`User`](internal-1.User.md)\> + +Creates a user with username being validated. +Fails if email is not a valid format. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `user` | [`CreateUserInput`](../interfaces/internal-8.CreateUserInput.md) | the user to create | +| `password` | `string` | user's password to hash | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the result of create + +#### Defined in + +packages/medusa/dist/services/user.d.ts:75 + +___ + +### delete + +▸ **delete**(`userId`): `Promise`<`void`\> + +Deletes a user from a given user id. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | the id of the user to delete. Must be castable as an ObjectId | + +#### Returns + +`Promise`<`void`\> + +the result of the delete operation. + +#### Defined in + +packages/medusa/dist/services/user.d.ts:89 + +___ + +### generateResetPasswordToken + +▸ **generateResetPasswordToken**(`userId`): `Promise`<`string`\> + +Generate a JSON Web token, that will be sent to a user, that wishes to +reset password. +The token will be signed with the users current password hash as a secret +a long side a payload with userId and the expiry time for the token, which +is always 15 minutes. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | the id of the user to reset password for | + +#### Returns + +`Promise`<`string`\> + +the generated JSON web token + +#### Defined in + +packages/medusa/dist/services/user.d.ts:108 + +___ + +### hashPassword\_ + +▸ **hashPassword_**(`password`): `Promise`<`string`\> + +Hashes a password + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `password` | `string` | the value to hash | + +#### Returns + +`Promise`<`string`\> + +hashed password + +#### Defined in + +packages/medusa/dist/services/user.d.ts:67 + +___ + +### list + +▸ **list**(`selector`, `config?`): `Promise`<[`User`](internal-1.User.md)[]\> + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | [`FilterableUserProps`](../modules/internal-8.md#filterableuserprops) | the query object for find | +| `config?` | `Object` | the configuration object for the query | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)[]\> + +the result of the find operation + +#### Defined in + +packages/medusa/dist/services/user.d.ts:37 + +___ + +### retrieve + +▸ **retrieve**(`userId`, `config?`): `Promise`<[`User`](internal-1.User.md)\> + +Gets a user by id. +Throws in case of DB Error and if user was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | the id of the user to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`User`](internal-1.User.md)\> | query configs | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the user document. + +#### Defined in + +packages/medusa/dist/services/user.d.ts:45 + +___ + +### retrieveByApiToken + +▸ **retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<[`User`](internal-1.User.md)\> + +Gets a user by api token. +Throws in case of DB Error and if user was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `apiToken` | `string` | the token of the user to get. | +| `relations?` | `string`[] | relations to include with the user. | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the user document. + +#### Defined in + +packages/medusa/dist/services/user.d.ts:53 + +___ + +### retrieveByEmail + +▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`User`](internal-1.User.md)\> + +Gets a user by email. +Throws in case of DB Error and if user was not found. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `email` | `string` | the email of the user to get. | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`User`](internal-1.User.md)\> | query config | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the user document. + +#### Defined in + +packages/medusa/dist/services/user.d.ts:61 + +___ + +### setPassword\_ + +▸ **setPassword_**(`userId`, `password`): `Promise`<[`User`](internal-1.User.md)\> + +Sets a password for a user +Fails if no user exists with userId and if the hashing of the new +password does not work. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | the userId to set password for | +| `password` | `string` | the old password to set | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the result of the update operation + +#### Defined in + +packages/medusa/dist/services/user.d.ts:98 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### update + +▸ **update**(`userId`, `update`): `Promise`<[`User`](internal-1.User.md)\> + +Updates a user. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `userId` | `string` | id of the user to update | +| `update` | [`UpdateUserInput`](../interfaces/internal-8.UpdateUserInput.md) | the values to be updated on the user | + +#### Returns + +`Promise`<[`User`](internal-1.User.md)\> + +the result of create + +#### Defined in + +packages/medusa/dist/services/user.d.ts:82 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`UserService`](internal-8.internal.UserService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`UserService`](internal-8.internal.UserService.md) + +#### Inherited from + +[TransactionBaseService](internal-8.internal.TransactionBaseService.md).[withTransaction](internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md b/www/apps/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md deleted file mode 100644 index dbfa863a82..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-9.AdminGetGiftCardsParams.md +++ /dev/null @@ -1,33 +0,0 @@ -# Class: AdminGetGiftCardsParams - -[internal](../modules/internal-9.md).AdminGetGiftCardsParams - -## Properties - -### limit - -• **limit**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:69 - -___ - -### offset - -• **offset**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:70 - -___ - -### q - -• `Optional` **q**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md b/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md deleted file mode 100644 index 727b55eb8b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsGiftCardReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminPostGiftCardsGiftCardReq - -[internal](../modules/internal-9.md).AdminPostGiftCardsGiftCardReq - -## Properties - -### balance - -• `Optional` **balance**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:84 - -___ - -### ends\_at - -• `Optional` **ends\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:86 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:85 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:88 - -___ - -### region\_id - -• `Optional` **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/update-gift-card.d.ts:87 diff --git a/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md b/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md deleted file mode 100644 index b775ad0be1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal-9.AdminPostGiftCardsReq.md +++ /dev/null @@ -1,53 +0,0 @@ -# Class: AdminPostGiftCardsReq - -[internal](../modules/internal-9.md).AdminPostGiftCardsReq - -## Properties - -### ends\_at - -• `Optional` **ends\_at**: `Date` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:85 - -___ - -### is\_disabled - -• `Optional` **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:86 - -___ - -### metadata - -• `Optional` **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:88 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:87 - -___ - -### value - -• `Optional` **value**: `number` - -#### Defined in - -medusa/dist/api/routes/admin/gift-cards/create-gift-card.d.ts:84 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Address.md b/www/apps/docs/content/references/js-client/classes/internal.Address.md deleted file mode 100644 index f768352c35..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Address.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Address - -[internal](../modules/internal.md).Address - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Address`** - -## Properties - -### address\_1 - -• **address\_1**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:10 - -___ - -### address\_2 - -• **address\_2**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:11 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/address.d.ts:19 - -___ - -### city - -• **city**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:12 - -___ - -### company - -• **company**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:7 - -___ - -### country - -• **country**: ``null`` \| [`Country`](internal.Country.md) - -#### Defined in - -medusa/dist/models/address.d.ts:14 - -___ - -### country\_code - -• **country\_code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:13 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customer - -• **customer**: ``null`` \| [`Customer`](internal.Customer.md) - -#### Defined in - -medusa/dist/models/address.d.ts:6 - -___ - -### customer\_id - -• **customer\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:5 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### first\_name - -• **first\_name**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:8 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### last\_name - -• **last\_name**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:9 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/address.d.ts:18 - -___ - -### phone - -• **phone**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:17 - -___ - -### postal\_code - -• **postal\_code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:16 - -___ - -### province - -• **province**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/address.d.ts:15 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md b/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md index eecb623583..09c1b52127 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md +++ b/www/apps/docs/content/references/js-client/classes/internal.AddressCreatePayload.md @@ -6,6 +6,65 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).AddressCreatePayload +**`Schema`** + +AddressCreatePayload +type: object +description: "Address fields used when creating an address." +required: + - first_name + - last_name + - address_1 + - city + - country_code + - postal_code +properties: + first_name: + description: First name + type: string + example: Arno + last_name: + description: Last name + type: string + example: Willms + phone: + type: string + description: Phone Number + example: 16128234334802 + company: + type: string + address_1: + description: Address line 1 + type: string + example: 14433 Kemmer Court + address_2: + description: Address line 2 + type: string + example: Suite 369 + city: + description: City + type: string + example: South Geoffreyview + country_code: + description: The 2 character ISO code of the country in lower case + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + description: Province + type: string + example: Kentucky + postal_code: + description: Postal Code + type: string + example: 72093 + metadata: + type: object + example: {car: "white"} + description: An optional key-value map with additional details + ## Properties ### address\_1 @@ -14,7 +73,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:109 +packages/medusa/dist/types/common.d.ts:231 ___ @@ -24,7 +83,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:110 +packages/medusa/dist/types/common.d.ts:232 ___ @@ -34,7 +93,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:111 +packages/medusa/dist/types/common.d.ts:233 ___ @@ -44,7 +103,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:108 +packages/medusa/dist/types/common.d.ts:230 ___ @@ -54,7 +113,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:112 +packages/medusa/dist/types/common.d.ts:234 ___ @@ -64,7 +123,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:104 +packages/medusa/dist/types/common.d.ts:226 ___ @@ -74,7 +133,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:105 +packages/medusa/dist/types/common.d.ts:227 ___ @@ -84,7 +143,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:107 +packages/medusa/dist/types/common.d.ts:229 ___ @@ -94,7 +153,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:106 +packages/medusa/dist/types/common.d.ts:228 ___ @@ -104,7 +163,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:114 +packages/medusa/dist/types/common.d.ts:236 ___ @@ -114,4 +173,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:113 +packages/medusa/dist/types/common.d.ts:235 diff --git a/www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md b/www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md index be8bb4050c..7d42d50da5 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md +++ b/www/apps/docs/content/references/js-client/classes/internal.AddressPayload.md @@ -6,6 +6,58 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).AddressPayload +**`Schema`** + +AddressPayload +type: object +description: "Address fields used when creating/updating an address." +properties: + first_name: + description: First name + type: string + example: Arno + last_name: + description: Last name + type: string + example: Willms + phone: + type: string + description: Phone Number + example: 16128234334802 + company: + type: string + address_1: + description: Address line 1 + type: string + example: 14433 Kemmer Court + address_2: + description: Address line 2 + type: string + example: Suite 369 + city: + description: City + type: string + example: South Geoffreyview + country_code: + description: The 2 character ISO code of the country in lower case + type: string + externalDocs: + url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements + description: See a list of codes. + example: st + province: + description: Province + type: string + example: Kentucky + postal_code: + description: Postal Code + type: string + example: 72093 + metadata: + type: object + example: {car: "white"} + description: An optional key-value map with additional details + ## Hierarchy - **`AddressPayload`** @@ -20,7 +72,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:96 +packages/medusa/dist/types/common.d.ts:160 ___ @@ -30,7 +82,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:97 +packages/medusa/dist/types/common.d.ts:161 ___ @@ -40,7 +92,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:98 +packages/medusa/dist/types/common.d.ts:162 ___ @@ -50,7 +102,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:95 +packages/medusa/dist/types/common.d.ts:159 ___ @@ -60,7 +112,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:99 +packages/medusa/dist/types/common.d.ts:163 ___ @@ -70,7 +122,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:91 +packages/medusa/dist/types/common.d.ts:155 ___ @@ -80,17 +132,17 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:92 +packages/medusa/dist/types/common.d.ts:156 ___ ### metadata -• `Optional` **metadata**: `Record`<`string`, `unknown`\> +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Defined in -medusa/dist/types/common.d.ts:94 +packages/medusa/dist/types/common.d.ts:158 ___ @@ -100,7 +152,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:93 +packages/medusa/dist/types/common.d.ts:157 ___ @@ -110,7 +162,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:101 +packages/medusa/dist/types/common.d.ts:165 ___ @@ -120,4 +172,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:100 +packages/medusa/dist/types/common.d.ts:164 diff --git a/www/apps/docs/content/references/js-client/classes/internal.BaseEntity.md b/www/apps/docs/content/references/js-client/classes/internal.BaseEntity.md deleted file mode 100644 index c08508be91..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.BaseEntity.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: BaseEntity - -[internal](../modules/internal.md).BaseEntity - -Base abstract entity for all entities - -## Hierarchy - -- **`BaseEntity`** - - ↳ [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ [`Order`](internal.Order.md) - - ↳ [`Payment`](internal.Payment.md) - - ↳ [`Fulfillment`](internal.Fulfillment.md) - - ↳ [`Return`](internal.Return.md) - - ↳ [`Refund`](internal.Refund.md) - - ↳ [`DraftOrder`](internal.DraftOrder.md) - - ↳ [`OrderEdit`](internal.OrderEdit.md) - - ↳ [`LineItem`](internal.LineItem.md) - - ↳ [`PaymentSession`](internal.PaymentSession.md) - - ↳ [`TaxRate`](internal.TaxRate.md) - - ↳ [`TaxLine`](internal.TaxLine.md) - - ↳ [`Notification`](internal-12.Notification.md) - - ↳ [`PublishableApiKey`](internal-21.PublishableApiKey.md) - - ↳ [`Store`](internal-28.Store.md) - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Cart.md b/www/apps/docs/content/references/js-client/classes/internal.Cart.md deleted file mode 100644 index 8dbe0714c1..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Cart.md +++ /dev/null @@ -1,461 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Cart - -[internal](../modules/internal.md).Cart - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Cart`** - -## Properties - -### afterLoad - -• `Private` **afterLoad**: `any` - -#### Defined in - -medusa/dist/models/cart.d.ts:227 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/cart.d.ts:228 - -___ - -### billing\_address - -• **billing\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:193 - -___ - -### billing\_address\_id - -• **billing\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:192 - -___ - -### completed\_at - -• **completed\_at**: `Date` - -#### Defined in - -medusa/dist/models/cart.d.ts:209 - -___ - -### context - -• **context**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/cart.d.ts:212 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customer - -• **customer**: [`Customer`](internal.Customer.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:202 - -___ - -### customer\_id - -• **customer\_id**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:201 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### discount\_total - -• `Optional` **discount\_total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:217 - -___ - -### discounts - -• **discounts**: [`Discount`](internal.Discount.md)[] - -#### Defined in - -medusa/dist/models/cart.d.ts:199 - -___ - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:191 - -___ - -### gift\_card\_tax\_total - -• `Optional` **gift\_card\_tax\_total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:226 - -___ - -### gift\_card\_total - -• `Optional` **gift\_card\_total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:225 - -___ - -### gift\_cards - -• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[] - -#### Defined in - -medusa/dist/models/cart.d.ts:200 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:211 - -___ - -### item\_tax\_total - -• `Optional` **item\_tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:218 - -___ - -### items - -• **items**: [`LineItem`](internal.LineItem.md)[] - -#### Defined in - -medusa/dist/models/cart.d.ts:196 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/cart.d.ts:213 - -___ - -### object - -• `Readonly` **object**: ``"cart"`` - -#### Defined in - -medusa/dist/models/cart.d.ts:190 - -___ - -### payment - -• **payment**: [`Payment`](internal.Payment.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:206 - -___ - -### payment\_authorized\_at - -• **payment\_authorized\_at**: `Date` - -#### Defined in - -medusa/dist/models/cart.d.ts:210 - -___ - -### payment\_id - -• **payment\_id**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:205 - -___ - -### payment\_session - -• **payment\_session**: ``null`` \| [`PaymentSession`](internal.PaymentSession.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:203 - -___ - -### payment\_sessions - -• **payment\_sessions**: [`PaymentSession`](internal.PaymentSession.md)[] - -#### Defined in - -medusa/dist/models/cart.d.ts:204 - -___ - -### refundable\_amount - -• `Optional` **refundable\_amount**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:224 - -___ - -### refunded\_total - -• `Optional` **refunded\_total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:221 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:198 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:197 - -___ - -### sales\_channel - -• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:215 - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:214 - -___ - -### shipping\_address - -• **shipping\_address**: ``null`` \| [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:195 - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/cart.d.ts:194 - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/models/cart.d.ts:207 - -___ - -### shipping\_tax\_total - -• `Optional` **shipping\_tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:219 - -___ - -### shipping\_total - -• `Optional` **shipping\_total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:216 - -___ - -### subtotal - -• `Optional` **subtotal**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:223 - -___ - -### tax\_total - -• `Optional` **tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:220 - -___ - -### total - -• `Optional` **total**: `number` - -#### Defined in - -medusa/dist/models/cart.d.ts:222 - -___ - -### type - -• **type**: [`CartType`](../enums/internal.CartType.md) - -#### Defined in - -medusa/dist/models/cart.d.ts:208 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ClaimImage.md b/www/apps/docs/content/references/js-client/classes/internal.ClaimImage.md deleted file mode 100644 index 49e09f0ce3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ClaimImage.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ClaimImage - -[internal](../modules/internal.md).ClaimImage - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ClaimImage`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/claim-image.d.ts:8 - -___ - -### claim\_item - -• **claim\_item**: [`ClaimItem`](internal.ClaimItem.md) - -#### Defined in - -medusa/dist/models/claim-image.d.ts:5 - -___ - -### claim\_item\_id - -• **claim\_item\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-image.d.ts:4 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/claim-image.d.ts:7 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### url - -• **url**: `string` - -#### Defined in - -medusa/dist/models/claim-image.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ClaimItem.md b/www/apps/docs/content/references/js-client/classes/internal.ClaimItem.md deleted file mode 100644 index 033ae0d869..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ClaimItem.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ClaimItem - -[internal](../modules/internal.md).ClaimItem - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ClaimItem`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:26 - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) - -#### Defined in - -medusa/dist/models/claim-item.d.ts:16 - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:15 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### images - -• **images**: [`ClaimImage`](internal.ClaimImage.md)[] - -#### Defined in - -medusa/dist/models/claim-item.d.ts:14 - -___ - -### item - -• **item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/claim-item.d.ts:18 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:17 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/claim-item.d.ts:25 - -___ - -### note - -• **note**: `string` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:22 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:23 - -___ - -### reason - -• **reason**: [`ClaimReason`](../enums/internal.ClaimReason.md) - -#### Defined in - -medusa/dist/models/claim-item.d.ts:21 - -___ - -### tags - -• **tags**: [`ClaimTag`](internal.ClaimTag.md)[] - -#### Defined in - -medusa/dist/models/claim-item.d.ts:24 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### variant - -• **variant**: [`ProductVariant`](internal.ProductVariant.md) - -#### Defined in - -medusa/dist/models/claim-item.d.ts:20 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-item.d.ts:19 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ClaimOrder.md b/www/apps/docs/content/references/js-client/classes/internal.ClaimOrder.md deleted file mode 100644 index 0e7d6be6fd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ClaimOrder.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ClaimOrder - -[internal](../modules/internal.md).ClaimOrder - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ClaimOrder`** - -## Properties - -### additional\_items - -• **additional\_items**: [`LineItem`](internal.LineItem.md)[] - -#### Defined in - -medusa/dist/models/claim-order.d.ts:33 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:50 - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:43 - -___ - -### claim\_items - -• **claim\_items**: [`ClaimItem`](internal.ClaimItem.md)[] - -#### Defined in - -medusa/dist/models/claim-order.d.ts:32 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Overrides - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:44 - -___ - -### deleted\_at - -• **deleted\_at**: `Date` - -#### Overrides - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:46 - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/internal.ClaimFulfillmentStatus.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:31 - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] - -#### Defined in - -medusa/dist/models/claim-order.d.ts:41 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:49 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/claim-order.d.ts:48 - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:47 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:36 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:35 - -___ - -### payment\_status - -• **payment\_status**: [`ClaimPaymentStatus`](../enums/internal.ClaimPaymentStatus.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:30 - -___ - -### refund\_amount - -• **refund\_amount**: `number` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:42 - -___ - -### return\_order - -• **return\_order**: [`Return`](internal.Return.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:37 - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:39 - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/claim-order.d.ts:38 - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/models/claim-order.d.ts:40 - -___ - -### type - -• **type**: [`ClaimType`](../enums/internal.ClaimType.md) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:34 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Overrides - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/models/claim-order.d.ts:45 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ClaimTag.md b/www/apps/docs/content/references/js-client/classes/internal.ClaimTag.md deleted file mode 100644 index 0d283af604..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ClaimTag.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ClaimTag - -[internal](../modules/internal.md).ClaimTag - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ClaimTag`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/claim-tag.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/claim-tag.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/claim-tag.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Client.md b/www/apps/docs/content/references/js-client/classes/internal.Client.md deleted file mode 100644 index 7d0a179e6a..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Client.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Client - -[internal](../modules/internal.md).Client - -## Properties - -### axiosClient - -• `Private` **axiosClient**: [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) - -#### Defined in - -[medusa-js/src/request.ts:34](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L34) - -___ - -### config - -• `Private` **config**: [`Config`](../interfaces/internal.Config.md) - -#### Defined in - -[medusa-js/src/request.ts:35](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L35) - -## Methods - -### createClient - -▸ **createClient**(`config`): [`AxiosInstance`](../interfaces/internal.AxiosInstance.md) - -Creates the axios client used for requests -As part of the creation, we configure the retry conditions -and the exponential backoff approach. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`Config`](../interfaces/internal.Config.md) | user supplied configurations | - -#### Returns - -[`AxiosInstance`](../interfaces/internal.AxiosInstance.md) - -#### Defined in - -[medusa-js/src/request.ts:158](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L158) - -___ - -### normalizeHeader - -▸ **normalizeHeader**(`header`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `header` | `string` | - -#### Returns - -`string` - -#### Defined in - -[medusa-js/src/request.ts:88](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L88) - -___ - -### normalizeHeaders - -▸ **normalizeHeaders**(`obj`): `Record`<`string`, `any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `obj` | `object` | - -#### Returns - -`Record`<`string`, `any`\> - -#### Defined in - -[medusa-js/src/request.ts:76](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L76) - -___ - -### request - -▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> - -Axios request - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method | -| `path` | `string` | request path | -| `payload` | `Record`<`string`, `any`\> | request payload | -| `options` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | axios configuration | -| `customHeaders` | `Record`<`string`, `any`\> | custom request headers | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[medusa-js/src/request.ts:195](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L195) - -___ - -### requiresAuthentication - -▸ **requiresAuthentication**(`path`, `method`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `any` | -| `method` | `any` | - -#### Returns - -`boolean` - -#### Defined in - -[medusa-js/src/request.ts:97](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L97) - -___ - -### setHeaders - -▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -Creates all the initial headers. -We add the idempotency key, if the request is configured to retry. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `userHeaders` | [`RequestOptions`](../interfaces/internal.RequestOptions.md) | user supplied headers | -| `method` | [`RequestMethod`](../modules/internal.md#requestmethod) | request method | -| `path` | `string` | request path | -| `customHeaders` | `Record`<`string`, `any`\> | user supplied headers | - -#### Returns - -[`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -[medusa-js/src/request.ts:113](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L113) - -___ - -### shouldRetryCondition - -▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | [`AxiosError`](../interfaces/internal.AxiosError.md)<`any`, `any`\> | -| `numRetries` | `number` | -| `maxRetries` | `number` | - -#### Returns - -`boolean` - -#### Defined in - -[medusa-js/src/request.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L45) diff --git a/www/apps/docs/content/references/js-client/classes/internal.Customer.md b/www/apps/docs/content/references/js-client/classes/internal.Customer.md deleted file mode 100644 index 6d2b70ec95..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Customer.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Customer - -[internal](../modules/internal.md).Customer - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Customer`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/customer.d.ts:18 - -___ - -### billing\_address - -• **billing\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/customer.d.ts:10 - -___ - -### billing\_address\_id - -• **billing\_address\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:9 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:6 - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:7 - -___ - -### groups - -• **groups**: [`CustomerGroup`](internal.CustomerGroup.md)[] - -#### Defined in - -medusa/dist/models/customer.d.ts:16 - -___ - -### has\_account - -• **has\_account**: `boolean` - -#### Defined in - -medusa/dist/models/customer.d.ts:14 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:8 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/customer.d.ts:17 - -___ - -### orders - -• **orders**: [`Order`](internal.Order.md)[] - -#### Defined in - -medusa/dist/models/customer.d.ts:15 - -___ - -### password\_hash - -• **password\_hash**: `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:12 - -___ - -### phone - -• **phone**: `string` - -#### Defined in - -medusa/dist/models/customer.d.ts:13 - -___ - -### shipping\_addresses - -• **shipping\_addresses**: [`Address`](internal.Address.md)[] - -#### Defined in - -medusa/dist/models/customer.d.ts:11 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.CustomerGroup.md b/www/apps/docs/content/references/js-client/classes/internal.CustomerGroup.md deleted file mode 100644 index d9764fce5e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.CustomerGroup.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: CustomerGroup - -[internal](../modules/internal.md).CustomerGroup - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`CustomerGroup`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/customer-group.d.ts:9 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customers - -• **customers**: [`Customer`](internal.Customer.md)[] - -#### Defined in - -medusa/dist/models/customer-group.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/customer-group.d.ts:8 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/customer-group.d.ts:5 - -___ - -### price\_lists - -• **price\_lists**: [`PriceList`](internal.PriceList.md)[] - -#### Defined in - -medusa/dist/models/customer-group.d.ts:7 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Discount.md b/www/apps/docs/content/references/js-client/classes/internal.Discount.md deleted file mode 100644 index 87be4942b8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Discount.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Discount - -[internal](../modules/internal.md).Discount - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Discount`** - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/models/discount.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### ends\_at - -• **ends\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/models/discount.d.ts:13 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/models/discount.d.ts:9 - -___ - -### is\_dynamic - -• **is\_dynamic**: `boolean` - -#### Defined in - -medusa/dist/models/discount.d.ts:6 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/discount.d.ts:18 - -___ - -### parent\_discount - -• **parent\_discount**: [`Discount`](internal.Discount.md) - -#### Defined in - -medusa/dist/models/discount.d.ts:11 - -___ - -### parent\_discount\_id - -• **parent\_discount\_id**: `string` - -#### Defined in - -medusa/dist/models/discount.d.ts:10 - -___ - -### regions - -• **regions**: [`Region`](internal.Region.md)[] - -#### Defined in - -medusa/dist/models/discount.d.ts:15 - -___ - -### rule - -• **rule**: [`DiscountRule`](internal.DiscountRule.md) - -#### Defined in - -medusa/dist/models/discount.d.ts:8 - -___ - -### rule\_id - -• **rule\_id**: `string` - -#### Defined in - -medusa/dist/models/discount.d.ts:7 - -___ - -### starts\_at - -• **starts\_at**: `Date` - -#### Defined in - -medusa/dist/models/discount.d.ts:12 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### upperCaseCodeAndTrim - -• `Private` **upperCaseCodeAndTrim**: `any` - -#### Defined in - -medusa/dist/models/discount.d.ts:19 - -___ - -### usage\_count - -• **usage\_count**: `number` - -#### Defined in - -medusa/dist/models/discount.d.ts:17 - -___ - -### usage\_limit - -• **usage\_limit**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/discount.d.ts:16 - -___ - -### valid\_duration - -• **valid\_duration**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/discount.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal.DiscountCondition.md b/www/apps/docs/content/references/js-client/classes/internal.DiscountCondition.md deleted file mode 100644 index 13de1a42dc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.DiscountCondition.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: DiscountCondition - -[internal](../modules/internal.md).DiscountCondition - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`DiscountCondition`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:30 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customer\_groups - -• **customer\_groups**: [`CustomerGroup`](internal.CustomerGroup.md)[] - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:28 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### discount\_rule - -• **discount\_rule**: [`DiscountRule`](internal.DiscountRule.md) - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:23 - -___ - -### discount\_rule\_id - -• **discount\_rule\_id**: `string` - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:22 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:29 - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md) - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:21 - -___ - -### product\_collections - -• **product\_collections**: [`ProductCollection`](internal.ProductCollection.md)[] - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:27 - -___ - -### product\_tags - -• **product\_tags**: [`ProductTag`](internal.ProductTag.md)[] - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:26 - -___ - -### product\_types - -• **product\_types**: [`ProductType`](internal.ProductType.md)[] - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:25 - -___ - -### products - -• **products**: [`Product`](internal.Product.md)[] - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:24 - -___ - -### type - -• **type**: [`DiscountConditionType`](../enums/internal.DiscountConditionType.md) - -#### Defined in - -medusa/dist/models/discount-condition.d.ts:20 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.DiscountRule.md b/www/apps/docs/content/references/js-client/classes/internal.DiscountRule.md deleted file mode 100644 index 964c1d6d91..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.DiscountRule.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: DiscountRule - -[internal](../modules/internal.md).DiscountRule - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`DiscountRule`** - -## Properties - -### allocation - -• **allocation**: [`AllocationType`](../enums/internal.AllocationType.md) - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:16 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:19 - -___ - -### conditions - -• **conditions**: [`DiscountCondition`](internal.DiscountCondition.md)[] - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:17 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:13 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:18 - -___ - -### type - -• **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md) - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:14 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `number` - -#### Defined in - -medusa/dist/models/discount-rule.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/classes/internal.DraftOrder.md b/www/apps/docs/content/references/js-client/classes/internal.DraftOrder.md deleted file mode 100644 index 83ce445515..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.DraftOrder.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: DraftOrder - -[internal](../modules/internal.md).DraftOrder - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`DraftOrder`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:20 - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:15 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/draft-order.d.ts:12 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:11 - -___ - -### completed\_at - -• **completed\_at**: `Date` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:16 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:10 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:19 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/draft-order.d.ts:18 - -___ - -### no\_notification\_order - -• **no\_notification\_order**: `boolean` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:17 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/draft-order.d.ts:14 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/draft-order.d.ts:13 - -___ - -### status - -• **status**: [`DraftOrderStatus`](../enums/internal.DraftOrderStatus.md) - -#### Defined in - -medusa/dist/models/draft-order.d.ts:9 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Fulfillment.md b/www/apps/docs/content/references/js-client/classes/internal.Fulfillment.md deleted file mode 100644 index f1fa1686d2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Fulfillment.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Fulfillment - -[internal](../modules/internal.md).Fulfillment - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Fulfillment`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:26 - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:23 - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:10 - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:9 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:21 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:25 - -___ - -### items - -• **items**: [`FulfillmentItem`](internal.FulfillmentItem.md)[] - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:18 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:24 - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:15 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:14 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:13 - -___ - -### provider - -• **provider**: [`FulfillmentProvider`](internal.FulfillmentProvider.md) - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:17 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:16 - -___ - -### shipped\_at - -• **shipped\_at**: `Date` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:22 - -___ - -### swap - -• **swap**: [`Swap`](internal.Swap.md) - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:12 - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:11 - -___ - -### tracking\_links - -• **tracking\_links**: [`TrackingLink`](internal.TrackingLink.md)[] - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:19 - -___ - -### tracking\_numbers - -• **tracking\_numbers**: `string`[] - -#### Defined in - -medusa/dist/models/fulfillment.d.ts:20 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.FulfillmentItem.md b/www/apps/docs/content/references/js-client/classes/internal.FulfillmentItem.md deleted file mode 100644 index 646c5f1fcc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.FulfillmentItem.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: FulfillmentItem - -[internal](../modules/internal.md).FulfillmentItem - -## Properties - -### fulfillment - -• **fulfillment**: [`Fulfillment`](internal.Fulfillment.md) - -#### Defined in - -medusa/dist/models/fulfillment-item.d.ts:6 - -___ - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment-item.d.ts:4 - -___ - -### item - -• **item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/fulfillment-item.d.ts:7 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/models/fulfillment-item.d.ts:5 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/models/fulfillment-item.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal.GiftCard.md b/www/apps/docs/content/references/js-client/classes/internal.GiftCard.md deleted file mode 100644 index 0d47e9e932..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.GiftCard.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: GiftCard - -[internal](../modules/internal.md).GiftCard - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`GiftCard`** - -## Properties - -### balance - -• **balance**: `number` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:7 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:15 - -___ - -### code - -• **code**: `string` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### ends\_at - -• **ends\_at**: `Date` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:13 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:12 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/gift-card.d.ts:14 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/gift-card.d.ts:11 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:10 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/gift-card.d.ts:9 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:8 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `number` - -#### Defined in - -medusa/dist/models/gift-card.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal.GiftCardTransaction.md b/www/apps/docs/content/references/js-client/classes/internal.GiftCardTransaction.md deleted file mode 100644 index 2922b33fec..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.GiftCardTransaction.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: GiftCardTransaction - -[internal](../modules/internal.md).GiftCardTransaction - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:9 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:13 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:10 - -___ - -### gift\_card - -• **gift\_card**: [`GiftCard`](internal.GiftCard.md) - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:6 - -___ - -### gift\_card\_id - -• **gift\_card\_id**: `string` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:5 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:4 - -___ - -### is\_taxable - -• **is\_taxable**: `boolean` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:11 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:8 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:7 - -___ - -### tax\_rate - -• **tax\_rate**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/gift-card-transaction.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Image.md b/www/apps/docs/content/references/js-client/classes/internal.Image.md deleted file mode 100644 index 32fc6530b3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Image.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Image - -[internal](../modules/internal.md).Image - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Image`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/image.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/image.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### url - -• **url**: `string` - -#### Defined in - -medusa/dist/models/image.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.LineItem.md b/www/apps/docs/content/references/js-client/classes/internal.LineItem.md deleted file mode 100644 index 3125ce2f46..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.LineItem.md +++ /dev/null @@ -1,447 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: LineItem - -[internal](../modules/internal.md).LineItem - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`LineItem`** - -## Properties - -### adjustments - -• **adjustments**: [`LineItemAdjustment`](internal.LineItemAdjustment.md)[] - -#### Defined in - -medusa/dist/models/line-item.d.ts:20 - -___ - -### allow\_discounts - -• **allow\_discounts**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:30 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/line-item.d.ts:49 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:12 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:11 - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:18 - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:17 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:25 - -___ - -### discount\_total - -• `Optional` **discount\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:47 - -___ - -### fulfilled\_quantity - -• **fulfilled\_quantity**: `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:36 - -___ - -### gift\_card\_total - -• `Optional` **gift\_card\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:48 - -___ - -### has\_shipping - -• **has\_shipping**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:31 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:40 - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:28 - -___ - -### is\_return - -• **is\_return**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:27 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/line-item.d.ts:39 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:14 - -___ - -### order\_edit - -• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](internal.OrderEdit.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:23 - -___ - -### order\_edit\_id - -• `Optional` **order\_edit\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:22 - -___ - -### order\_id - -• **order\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:13 - -___ - -### original\_item\_id - -• `Optional` **original\_item\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:21 - -___ - -### original\_tax\_total - -• `Optional` **original\_tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:46 - -___ - -### original\_total - -• `Optional` **original\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:45 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:35 - -___ - -### refundable - -• `Optional` **refundable**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:41 - -___ - -### returned\_quantity - -• **returned\_quantity**: `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:37 - -___ - -### shipped\_quantity - -• **shipped\_quantity**: `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:38 - -___ - -### should\_merge - -• **should\_merge**: `boolean` - -#### Defined in - -medusa/dist/models/line-item.d.ts:29 - -___ - -### subtotal - -• `Optional` **subtotal**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:42 - -___ - -### swap - -• **swap**: [`Swap`](internal.Swap.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:16 - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:15 - -___ - -### tax\_lines - -• **tax\_lines**: [`LineItemTaxLine`](internal.LineItemTaxLine.md)[] - -#### Defined in - -medusa/dist/models/line-item.d.ts:19 - -___ - -### tax\_total - -• `Optional` **tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:43 - -___ - -### thumbnail - -• **thumbnail**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:26 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:24 - -___ - -### total - -• `Optional` **total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:44 - -___ - -### unit\_price - -• **unit\_price**: `number` - -#### Defined in - -medusa/dist/models/line-item.d.ts:32 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### variant - -• **variant**: [`ProductVariant`](internal.ProductVariant.md) - -#### Defined in - -medusa/dist/models/line-item.d.ts:34 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item.d.ts:33 diff --git a/www/apps/docs/content/references/js-client/classes/internal.LineItemAdjustment.md b/www/apps/docs/content/references/js-client/classes/internal.LineItemAdjustment.md deleted file mode 100644 index 9e5d1cd55c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.LineItemAdjustment.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: LineItemAdjustment - -[internal](../modules/internal.md).LineItemAdjustment - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:10 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:12 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:7 - -___ - -### discount - -• **discount**: [`Discount`](internal.Discount.md) - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:8 - -___ - -### discount\_id - -• **discount\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:9 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:4 - -___ - -### item - -• **item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:6 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/line-item-adjustment.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/classes/internal.LineItemTaxLine.md b/www/apps/docs/content/references/js-client/classes/internal.LineItemTaxLine.md deleted file mode 100644 index 35adc8adfa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.LineItemTaxLine.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: LineItemTaxLine - -[internal](../modules/internal.md).LineItemTaxLine - -Base abstract entity for all entities - -## Hierarchy - -- [`TaxLine`](internal.TaxLine.md) - - ↳ **`LineItemTaxLine`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/line-item-tax-line.d.ts:6 - -___ - -### code - -• **code**: ``null`` \| `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[code](internal.TaxLine.md#code) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[created_at](internal.TaxLine.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[id](internal.TaxLine.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### item - -• **item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/line-item-tax-line.d.ts:5 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/models/line-item-tax-line.d.ts:4 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[metadata](internal.TaxLine.md#metadata) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:6 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[name](internal.TaxLine.md#name) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:4 - -___ - -### rate - -• **rate**: `number` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[rate](internal.TaxLine.md#rate) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:3 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[updated_at](internal.TaxLine.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.MoneyAmount.md b/www/apps/docs/content/references/js-client/classes/internal.MoneyAmount.md deleted file mode 100644 index ee3ed62f69..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.MoneyAmount.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: MoneyAmount - -[internal](../modules/internal.md).MoneyAmount - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`MoneyAmount`** - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:9 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:18 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### currency - -• `Optional` **currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/money-amount.d.ts:8 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:7 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### max\_quantity - -• **max\_quantity**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:11 - -___ - -### min\_quantity - -• **min\_quantity**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:10 - -___ - -### price\_list - -• **price\_list**: ``null`` \| [`PriceList`](internal.PriceList.md) - -#### Defined in - -medusa/dist/models/money-amount.d.ts:13 - -___ - -### price\_list\_id - -• **price\_list\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:12 - -___ - -### region - -• `Optional` **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/money-amount.d.ts:17 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:16 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### variant - -• **variant**: [`ProductVariant`](internal.ProductVariant.md) - -#### Defined in - -medusa/dist/models/money-amount.d.ts:15 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/models/money-amount.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Order.md b/www/apps/docs/content/references/js-client/classes/internal.Order.md deleted file mode 100644 index 69242b99ad..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Order.md +++ /dev/null @@ -1,567 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Order - -[internal](../modules/internal.md).Order - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Order`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/order.d.ts:99 - -___ - -### billing\_address - -• **billing\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/order.d.ts:60 - -___ - -### billing\_address\_id - -• **billing\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:59 - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -medusa/dist/models/order.d.ts:82 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/order.d.ts:55 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:54 - -___ - -### claims - -• **claims**: [`ClaimOrder`](internal.ClaimOrder.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:74 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### currency - -• **currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/order.d.ts:66 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:65 - -___ - -### customer - -• **customer**: [`Customer`](internal.Customer.md) - -#### Defined in - -medusa/dist/models/order.d.ts:57 - -___ - -### customer\_id - -• **customer\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:56 - -___ - -### discount\_total - -• **discount\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:90 - -___ - -### discounts - -• **discounts**: [`Discount`](internal.Discount.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:68 - -___ - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:53 - -___ - -### draft\_order - -• **draft\_order**: [`DraftOrder`](internal.DraftOrder.md) - -#### Defined in - -medusa/dist/models/order.d.ts:78 - -___ - -### draft\_order\_id - -• **draft\_order\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:77 - -___ - -### edits - -• **edits**: [`OrderEdit`](internal.OrderEdit.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:79 - -___ - -### email - -• **email**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:58 - -___ - -### external\_id - -• **external\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/order.d.ts:86 - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`FulfillmentStatus`](../enums/internal.FulfillmentStatus.md) - -#### Defined in - -medusa/dist/models/order.d.ts:51 - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:72 - -___ - -### gift\_card\_tax\_total - -• **gift\_card\_tax\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:98 - -___ - -### gift\_card\_total - -• **gift\_card\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:97 - -___ - -### gift\_card\_transactions - -• **gift\_card\_transactions**: [`GiftCardTransaction`](internal.GiftCardTransaction.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:81 - -___ - -### gift\_cards - -• **gift\_cards**: [`GiftCard`](internal.GiftCard.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:69 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:85 - -___ - -### items - -• **items**: [`LineItem`](internal.LineItem.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:80 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/order.d.ts:83 - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/models/order.d.ts:84 - -___ - -### object - -• `Readonly` **object**: ``"order"`` - -#### Defined in - -medusa/dist/models/order.d.ts:49 - -___ - -### paid\_total - -• **paid\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:95 - -___ - -### payment\_status - -• **payment\_status**: [`PaymentStatus`](../enums/internal.PaymentStatus.md) - -#### Defined in - -medusa/dist/models/order.d.ts:52 - -___ - -### payments - -• **payments**: [`Payment`](internal.Payment.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:71 - -___ - -### refundable\_amount - -• **refundable\_amount**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:96 - -___ - -### refunded\_total - -• **refunded\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:92 - -___ - -### refunds - -• **refunds**: [`Refund`](internal.Refund.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:75 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/order.d.ts:64 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:63 - -___ - -### returns - -• **returns**: [`Return`](internal.Return.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:73 - -___ - -### sales\_channel - -• **sales\_channel**: [`SalesChannel`](internal.SalesChannel.md) - -#### Defined in - -medusa/dist/models/order.d.ts:88 - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/order.d.ts:87 - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/order.d.ts:62 - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/order.d.ts:61 - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:70 - -___ - -### shipping\_total - -• **shipping\_total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:89 - -___ - -### status - -• **status**: [`OrderStatus`](../enums/internal.OrderStatus.md) - -#### Defined in - -medusa/dist/models/order.d.ts:50 - -___ - -### subtotal - -• **subtotal**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:94 - -___ - -### swaps - -• **swaps**: [`Swap`](internal.Swap.md)[] - -#### Defined in - -medusa/dist/models/order.d.ts:76 - -___ - -### tax\_rate - -• **tax\_rate**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/order.d.ts:67 - -___ - -### tax\_total - -• **tax\_total**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/order.d.ts:91 - -___ - -### total - -• **total**: `number` - -#### Defined in - -medusa/dist/models/order.d.ts:93 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.OrderItemChange.md b/www/apps/docs/content/references/js-client/classes/internal.OrderItemChange.md deleted file mode 100644 index 56f01702da..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.OrderItemChange.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: OrderItemChange - -[internal](../modules/internal.md).OrderItemChange - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`OrderItemChange`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:17 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### line\_item - -• `Optional` **line\_item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:16 - -___ - -### line\_item\_id - -• `Optional` **line\_item\_id**: `string` - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:15 - -___ - -### order\_edit - -• **order\_edit**: [`OrderEdit`](internal.OrderEdit.md) - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:12 - -___ - -### order\_edit\_id - -• **order\_edit\_id**: `string` - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:11 - -___ - -### original\_line\_item - -• `Optional` **original\_line\_item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:14 - -___ - -### original\_line\_item\_id - -• `Optional` **original\_line\_item\_id**: `string` - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:13 - -___ - -### type - -• **type**: [`OrderEditItemChangeType`](../enums/internal.OrderEditItemChangeType.md) - -#### Defined in - -medusa/dist/models/order-item-change.d.ts:10 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Payment.md b/www/apps/docs/content/references/js-client/classes/internal.Payment.md deleted file mode 100644 index 357e9cb656..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Payment.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Payment - -[internal](../modules/internal.md).Payment - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Payment`** - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/payment.d.ts:13 - -___ - -### amount\_refunded - -• **amount\_refunded**: `number` - -#### Defined in - -medusa/dist/models/payment.d.ts:16 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/payment.d.ts:23 - -___ - -### canceled\_at - -• **canceled\_at**: `string` \| `Date` - -#### Defined in - -medusa/dist/models/payment.d.ts:20 - -___ - -### captured\_at - -• **captured\_at**: `string` \| `Date` - -#### Defined in - -medusa/dist/models/payment.d.ts:19 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/payment.d.ts:10 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:9 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### currency - -• **currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/payment.d.ts:15 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:14 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/payment.d.ts:18 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:22 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/payment.d.ts:21 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/payment.d.ts:12 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:11 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:17 - -___ - -### swap - -• **swap**: [`Swap`](internal.Swap.md) - -#### Defined in - -medusa/dist/models/payment.d.ts:8 - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -medusa/dist/models/payment.d.ts:7 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.PaymentCollection.md b/www/apps/docs/content/references/js-client/classes/internal.PaymentCollection.md deleted file mode 100644 index 3f7d9e7144..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.PaymentCollection.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentCollection - -[internal](../modules/internal.md).PaymentCollection - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`PaymentCollection`** - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:17 - -___ - -### authorized\_amount - -• **authorized\_amount**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:18 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:27 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### created\_by - -• **created\_by**: `string` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:26 - -___ - -### currency - -• **currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:22 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:21 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:16 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:25 - -___ - -### payment\_sessions - -• **payment\_sessions**: [`PaymentSession`](internal.PaymentSession.md)[] - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:23 - -___ - -### payments - -• **payments**: [`Payment`](internal.Payment.md)[] - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:24 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:20 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:19 - -___ - -### status - -• **status**: [`PaymentCollectionStatus`](../enums/internal.PaymentCollectionStatus.md) - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:15 - -___ - -### type - -• **type**: [`ORDER_EDIT`](../modules/internal.md#order_edit) - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:14 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.PaymentSession.md b/www/apps/docs/content/references/js-client/classes/internal.PaymentSession.md deleted file mode 100644 index fd65700a35..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.PaymentSession.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PaymentSession - -[internal](../modules/internal.md).PaymentSession - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`PaymentSession`** - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:18 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:20 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/payment-session.d.ts:12 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:11 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/payment-session.d.ts:16 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:17 - -___ - -### is\_selected - -• **is\_selected**: ``null`` \| `boolean` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:14 - -___ - -### payment\_authorized\_at - -• **payment\_authorized\_at**: `Date` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:19 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:13 - -___ - -### status - -• **status**: `string` - -#### Defined in - -medusa/dist/models/payment-session.d.ts:15 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.PriceList.md b/www/apps/docs/content/references/js-client/classes/internal.PriceList.md deleted file mode 100644 index f08dc0d3dd..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.PriceList.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: PriceList - -[internal](../modules/internal.md).PriceList - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`PriceList`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/price-list.d.ts:15 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### customer\_groups - -• **customer\_groups**: [`CustomerGroup`](internal.CustomerGroup.md)[] - -#### Defined in - -medusa/dist/models/price-list.d.ts:12 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/models/price-list.d.ts:7 - -___ - -### ends\_at - -• **ends\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/models/price-list.d.ts:11 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/models/price-list.d.ts:14 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/price-list.d.ts:6 - -___ - -### prices - -• **prices**: [`MoneyAmount`](internal.MoneyAmount.md)[] - -#### Defined in - -medusa/dist/models/price-list.d.ts:13 - -___ - -### starts\_at - -• **starts\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/models/price-list.d.ts:10 - -___ - -### status - -• **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md) - -#### Defined in - -medusa/dist/models/price-list.d.ts:9 - -___ - -### type - -• **type**: [`PriceListType`](../enums/internal.PriceListType.md) - -#### Defined in - -medusa/dist/models/price-list.d.ts:8 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Product.md b/www/apps/docs/content/references/js-client/classes/internal.Product.md deleted file mode 100644 index f1248fa83c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Product.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Product - -[internal](../modules/internal.md).Product - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Product`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product.d.ts:46 - -___ - -### collection - -• **collection**: [`ProductCollection`](internal.ProductCollection.md) - -#### Defined in - -medusa/dist/models/product.d.ts:38 - -___ - -### collection\_id - -• **collection\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:37 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:19 - -___ - -### discountable - -• **discountable**: `boolean` - -#### Defined in - -medusa/dist/models/product.d.ts:42 - -___ - -### external\_id - -• **external\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:43 - -___ - -### handle - -• **handle**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:20 - -___ - -### height - -• **height**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/product.d.ts:31 - -___ - -### hs\_code - -• **hs\_code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:33 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### images - -• **images**: [`Image`](internal.Image.md)[] - -#### Defined in - -medusa/dist/models/product.d.ts:23 - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -medusa/dist/models/product.d.ts:21 - -___ - -### length - -• **length**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/product.d.ts:30 - -___ - -### material - -• **material**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:36 - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product.d.ts:44 - -___ - -### mid\_code - -• **mid\_code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:35 - -___ - -### options - -• **options**: [`ProductOption`](internal.ProductOption.md)[] - -#### Defined in - -medusa/dist/models/product.d.ts:25 - -___ - -### origin\_country - -• **origin\_country**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:34 - -___ - -### profile - -• **profile**: [`ShippingProfile`](internal.ShippingProfile.md) - -#### Defined in - -medusa/dist/models/product.d.ts:28 - -___ - -### profile\_id - -• **profile\_id**: `string` - -#### Defined in - -medusa/dist/models/product.d.ts:27 - -___ - -### sales\_channels - -• **sales\_channels**: [`SalesChannel`](internal.SalesChannel.md)[] - -#### Defined in - -medusa/dist/models/product.d.ts:45 - -___ - -### status - -• **status**: [`ProductStatus`](../enums/internal.ProductStatus.md) - -#### Defined in - -medusa/dist/models/product.d.ts:22 - -___ - -### subtitle - -• **subtitle**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:18 - -___ - -### tags - -• **tags**: [`ProductTag`](internal.ProductTag.md)[] - -#### Defined in - -medusa/dist/models/product.d.ts:41 - -___ - -### thumbnail - -• **thumbnail**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:24 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/product.d.ts:17 - -___ - -### type - -• **type**: [`ProductType`](internal.ProductType.md) - -#### Defined in - -medusa/dist/models/product.d.ts:40 - -___ - -### type\_id - -• **type\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/product.d.ts:39 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### variants - -• **variants**: [`ProductVariant`](internal.ProductVariant.md)[] - -#### Defined in - -medusa/dist/models/product.d.ts:26 - -___ - -### weight - -• **weight**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/product.d.ts:29 - -___ - -### width - -• **width**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/product.d.ts:32 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductCollection.md b/www/apps/docs/content/references/js-client/classes/internal.ProductCollection.md deleted file mode 100644 index e2b187687f..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductCollection.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductCollection - -[internal](../modules/internal.md).ProductCollection - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductCollection`** - -## Properties - -### createHandleIfNotProvided - -• `Private` **createHandleIfNotProvided**: `any` - -#### Defined in - -medusa/dist/models/product-collection.d.ts:8 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### handle - -• **handle**: `string` - -#### Defined in - -medusa/dist/models/product-collection.d.ts:5 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-collection.d.ts:7 - -___ - -### products - -• **products**: [`Product`](internal.Product.md)[] - -#### Defined in - -medusa/dist/models/product-collection.d.ts:6 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/product-collection.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductOption.md b/www/apps/docs/content/references/js-client/classes/internal.ProductOption.md deleted file mode 100644 index df3d619083..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductOption.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductOption - -[internal](../modules/internal.md).ProductOption - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductOption`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product-option.d.ts:10 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-option.d.ts:9 - -___ - -### product - -• **product**: [`Product`](internal.Product.md) - -#### Defined in - -medusa/dist/models/product-option.d.ts:8 - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -medusa/dist/models/product-option.d.ts:7 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/product-option.d.ts:5 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### values - -• **values**: [`ProductOptionValue`](internal.ProductOptionValue.md)[] - -#### Defined in - -medusa/dist/models/product-option.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductOptionValue.md b/www/apps/docs/content/references/js-client/classes/internal.ProductOptionValue.md deleted file mode 100644 index c74ab39f48..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductOptionValue.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductOptionValue - -[internal](../modules/internal.md).ProductOptionValue - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductOptionValue`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:11 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:10 - -___ - -### option - -• **option**: [`ProductOption`](internal.ProductOption.md) - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:7 - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:6 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:5 - -___ - -### variant - -• **variant**: [`ProductVariant`](internal.ProductVariant.md) - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:9 - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -medusa/dist/models/product-option-value.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductTag.md b/www/apps/docs/content/references/js-client/classes/internal.ProductTag.md deleted file mode 100644 index 0f9b3cdb03..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductTag.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductTag - -[internal](../modules/internal.md).ProductTag - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductTag`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product-tag.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-tag.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/product-tag.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductType.md b/www/apps/docs/content/references/js-client/classes/internal.ProductType.md deleted file mode 100644 index 5a0898e1f4..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductType.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductType - -[internal](../modules/internal.md).ProductType - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductType`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product-type.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-type.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/product-type.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ProductVariant.md b/www/apps/docs/content/references/js-client/classes/internal.ProductVariant.md deleted file mode 100644 index 6a4e03e6c8..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ProductVariant.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ProductVariant - -[internal](../modules/internal.md).ProductVariant - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ProductVariant`** - -## Properties - -### allow\_backorder - -• **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:16 - -___ - -### barcode - -• **barcode**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:11 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:28 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### ean - -• **ean**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:12 - -___ - -### height - -• **height**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:24 - -___ - -### hs\_code - -• **hs\_code**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:18 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### inventory\_quantity - -• **inventory\_quantity**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:15 - -___ - -### length - -• **length**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:23 - -___ - -### manage\_inventory - -• **manage\_inventory**: `boolean` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:17 - -___ - -### material - -• **material**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:21 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/product-variant.d.ts:27 - -___ - -### mid\_code - -• **mid\_code**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:20 - -___ - -### options - -• **options**: [`ProductOptionValue`](internal.ProductOptionValue.md)[] - -#### Defined in - -medusa/dist/models/product-variant.d.ts:26 - -___ - -### origin\_country - -• **origin\_country**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:19 - -___ - -### prices - -• **prices**: [`MoneyAmount`](internal.MoneyAmount.md)[] - -#### Defined in - -medusa/dist/models/product-variant.d.ts:9 - -___ - -### product - -• **product**: [`Product`](internal.Product.md) - -#### Defined in - -medusa/dist/models/product-variant.d.ts:8 - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:7 - -___ - -### sku - -• **sku**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:10 - -___ - -### title - -• **title**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:6 - -___ - -### upc - -• **upc**: `string` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:13 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### variant\_rank - -• **variant\_rank**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:14 - -___ - -### weight - -• **weight**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:22 - -___ - -### width - -• **width**: `number` - -#### Defined in - -medusa/dist/models/product-variant.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Refund.md b/www/apps/docs/content/references/js-client/classes/internal.Refund.md deleted file mode 100644 index c65887998e..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Refund.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Refund - -[internal](../modules/internal.md).Refund - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Refund`** - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/refund.d.ts:16 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/refund.d.ts:21 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/refund.d.ts:20 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/refund.d.ts:19 - -___ - -### note - -• **note**: `string` - -#### Defined in - -medusa/dist/models/refund.d.ts:17 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/refund.d.ts:14 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/refund.d.ts:12 - -___ - -### payment - -• **payment**: [`Payment`](internal.Payment.md) - -#### Defined in - -medusa/dist/models/refund.d.ts:15 - -___ - -### payment\_id - -• **payment\_id**: `string` - -#### Defined in - -medusa/dist/models/refund.d.ts:13 - -___ - -### reason - -• **reason**: `string` - -#### Defined in - -medusa/dist/models/refund.d.ts:18 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Region.md b/www/apps/docs/content/references/js-client/classes/internal.Region.md deleted file mode 100644 index 698facbc9c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Region.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Region - -[internal](../modules/internal.md).Region - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Region`** - -## Properties - -### automatic\_taxes - -• **automatic\_taxes**: `boolean` - -#### Defined in - -medusa/dist/models/region.d.ts:16 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/region.d.ts:24 - -___ - -### countries - -• **countries**: [`Country`](internal.Country.md)[] - -#### Defined in - -medusa/dist/models/region.d.ts:17 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### currency - -• **currency**: [`Currency`](internal.Currency.md) - -#### Defined in - -medusa/dist/models/region.d.ts:11 - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -medusa/dist/models/region.d.ts:10 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### fulfillment\_providers - -• **fulfillment\_providers**: [`FulfillmentProvider`](internal.FulfillmentProvider.md)[] - -#### Defined in - -medusa/dist/models/region.d.ts:21 - -___ - -### gift\_cards\_taxable - -• **gift\_cards\_taxable**: `boolean` - -#### Defined in - -medusa/dist/models/region.d.ts:15 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/models/region.d.ts:23 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/region.d.ts:22 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/region.d.ts:9 - -___ - -### payment\_providers - -• **payment\_providers**: [`PaymentProvider`](internal.PaymentProvider.md)[] - -#### Defined in - -medusa/dist/models/region.d.ts:20 - -___ - -### tax\_code - -• **tax\_code**: `string` - -#### Defined in - -medusa/dist/models/region.d.ts:14 - -___ - -### tax\_provider - -• **tax\_provider**: [`TaxProvider`](internal.TaxProvider.md) - -#### Defined in - -medusa/dist/models/region.d.ts:19 - -___ - -### tax\_provider\_id - -• **tax\_provider\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/region.d.ts:18 - -___ - -### tax\_rate - -• **tax\_rate**: `number` - -#### Defined in - -medusa/dist/models/region.d.ts:12 - -___ - -### tax\_rates - -• **tax\_rates**: ``null`` \| [`TaxRate`](internal.TaxRate.md)[] - -#### Defined in - -medusa/dist/models/region.d.ts:13 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Return.md b/www/apps/docs/content/references/js-client/classes/internal.Return.md deleted file mode 100644 index e23c97c5b3..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Return.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Return - -[internal](../modules/internal.md).Return - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`Return`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/return.d.ts:29 - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) - -#### Defined in - -medusa/dist/models/return.d.ts:19 - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -medusa/dist/models/return.d.ts:18 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/return.d.ts:28 - -___ - -### items - -• **items**: [`ReturnItem`](internal.ReturnItem.md)[] - -#### Defined in - -medusa/dist/models/return.d.ts:15 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/return.d.ts:27 - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/models/return.d.ts:26 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/return.d.ts:21 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/return.d.ts:20 - -___ - -### received\_at - -• **received\_at**: `Date` - -#### Defined in - -medusa/dist/models/return.d.ts:25 - -___ - -### refund\_amount - -• **refund\_amount**: `number` - -#### Defined in - -medusa/dist/models/return.d.ts:24 - -___ - -### shipping\_data - -• **shipping\_data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/return.d.ts:23 - -___ - -### shipping\_method - -• **shipping\_method**: [`ShippingMethod`](internal.ShippingMethod.md) - -#### Defined in - -medusa/dist/models/return.d.ts:22 - -___ - -### status - -• **status**: [`ReturnStatus`](../enums/internal.ReturnStatus.md) - -#### Defined in - -medusa/dist/models/return.d.ts:14 - -___ - -### swap - -• **swap**: [`Swap`](internal.Swap.md) - -#### Defined in - -medusa/dist/models/return.d.ts:17 - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -medusa/dist/models/return.d.ts:16 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ReturnItem.md b/www/apps/docs/content/references/js-client/classes/internal.ReturnItem.md deleted file mode 100644 index 0e1c260903..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ReturnItem.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ReturnItem - -[internal](../modules/internal.md).ReturnItem - -## Properties - -### is\_requested - -• **is\_requested**: `boolean` - -#### Defined in - -medusa/dist/models/return-item.d.ts:10 - -___ - -### item - -• **item**: [`LineItem`](internal.LineItem.md) - -#### Defined in - -medusa/dist/models/return-item.d.ts:8 - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -medusa/dist/models/return-item.d.ts:6 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/return-item.d.ts:16 - -___ - -### note - -• **note**: `string` - -#### Defined in - -medusa/dist/models/return-item.d.ts:15 - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -medusa/dist/models/return-item.d.ts:9 - -___ - -### reason - -• **reason**: [`ReturnReason`](internal.ReturnReason.md) - -#### Defined in - -medusa/dist/models/return-item.d.ts:14 - -___ - -### reason\_id - -• **reason\_id**: `string` - -#### Defined in - -medusa/dist/models/return-item.d.ts:13 - -___ - -### received\_quantity - -• **received\_quantity**: `number` - -#### Defined in - -medusa/dist/models/return-item.d.ts:12 - -___ - -### requested\_quantity - -• **requested\_quantity**: `number` - -#### Defined in - -medusa/dist/models/return-item.d.ts:11 - -___ - -### return\_id - -• **return\_id**: `string` - -#### Defined in - -medusa/dist/models/return-item.d.ts:5 - -___ - -### return\_order - -• **return\_order**: [`Return`](internal.Return.md) - -#### Defined in - -medusa/dist/models/return-item.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ReturnReason.md b/www/apps/docs/content/references/js-client/classes/internal.ReturnReason.md deleted file mode 100644 index 6d0ccf92f0..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ReturnReason.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ReturnReason - -[internal](../modules/internal.md).ReturnReason - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ReturnReason`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/return-reason.d.ts:10 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: `string` - -#### Defined in - -medusa/dist/models/return-reason.d.ts:5 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### label - -• **label**: `string` - -#### Defined in - -medusa/dist/models/return-reason.d.ts:4 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/return-reason.d.ts:9 - -___ - -### parent\_return\_reason - -• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](internal.ReturnReason.md) - -#### Defined in - -medusa/dist/models/return-reason.d.ts:7 - -___ - -### parent\_return\_reason\_id - -• **parent\_return\_reason\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/return-reason.d.ts:6 - -___ - -### return\_reason\_children - -• **return\_reason\_children**: [`ReturnReason`](internal.ReturnReason.md)[] - -#### Defined in - -medusa/dist/models/return-reason.d.ts:8 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### value - -• **value**: `string` - -#### Defined in - -medusa/dist/models/return-reason.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/classes/internal.SalesChannel.md b/www/apps/docs/content/references/js-client/classes/internal.SalesChannel.md deleted file mode 100644 index 6ada8e5e38..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.SalesChannel.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: SalesChannel - -[internal](../modules/internal.md).SalesChannel - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`SalesChannel`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/sales-channel.d.ts:6 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/sales-channel.d.ts:4 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -medusa/dist/models/sales-channel.d.ts:5 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/sales-channel.d.ts:3 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ShippingMethod.md b/www/apps/docs/content/references/js-client/classes/internal.ShippingMethod.md deleted file mode 100644 index 9a5adcfd7b..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ShippingMethod.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingMethod - -[internal](../modules/internal.md).ShippingMethod - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:29 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:16 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:15 - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](internal.ClaimOrder.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:14 - -___ - -### claim\_order\_id - -• **claim\_order\_id**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:13 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:24 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:9 - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:25 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:12 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:11 - -___ - -### price - -• **price**: `number` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:23 - -___ - -### return\_id - -• **return\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:19 - -___ - -### return\_order - -• **return\_order**: [`Return`](internal.Return.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:20 - -___ - -### shipping\_option - -• **shipping\_option**: [`ShippingOption`](internal.ShippingOption.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:21 - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:10 - -___ - -### subtotal - -• `Optional` **subtotal**: `number` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:26 - -___ - -### swap - -• **swap**: [`Swap`](internal.Swap.md) - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:18 - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:17 - -___ - -### tax\_lines - -• **tax\_lines**: [`ShippingMethodTaxLine`](internal.ShippingMethodTaxLine.md)[] - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:22 - -___ - -### tax\_total - -• `Optional` **tax\_total**: `number` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:28 - -___ - -### total - -• `Optional` **total**: `number` - -#### Defined in - -medusa/dist/models/shipping-method.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md b/www/apps/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md deleted file mode 100644 index d1f050fab2..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ShippingMethodTaxLine.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingMethodTaxLine - -[internal](../modules/internal.md).ShippingMethodTaxLine - -Base abstract entity for all entities - -## Hierarchy - -- [`TaxLine`](internal.TaxLine.md) - - ↳ **`ShippingMethodTaxLine`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/shipping-method-tax-line.d.ts:6 - -___ - -### code - -• **code**: ``null`` \| `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[code](internal.TaxLine.md#code) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[created_at](internal.TaxLine.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[id](internal.TaxLine.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[metadata](internal.TaxLine.md#metadata) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:6 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[name](internal.TaxLine.md#name) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:4 - -___ - -### rate - -• **rate**: `number` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[rate](internal.TaxLine.md#rate) - -#### Defined in - -medusa/dist/models/tax-line.d.ts:3 - -___ - -### shipping\_method - -• **shipping\_method**: [`ShippingMethod`](internal.ShippingMethod.md) - -#### Defined in - -medusa/dist/models/shipping-method-tax-line.d.ts:5 - -___ - -### shipping\_method\_id - -• **shipping\_method\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-method-tax-line.d.ts:4 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[TaxLine](internal.TaxLine.md).[updated_at](internal.TaxLine.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ShippingOption.md b/www/apps/docs/content/references/js-client/classes/internal.ShippingOption.md deleted file mode 100644 index e2635bd0fc..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ShippingOption.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingOption - -[internal](../modules/internal.md).ShippingOption - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ShippingOption`** - -## Properties - -### admin\_only - -• **admin\_only**: `boolean` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:21 - -___ - -### amount - -• **amount**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:19 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:26 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:23 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:25 - -___ - -### is\_return - -• **is\_return**: `boolean` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:20 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:24 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:11 - -___ - -### price\_type - -• **price\_type**: [`ShippingOptionPriceType`](../enums/internal.ShippingOptionPriceType.md) - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:18 - -___ - -### profile - -• **profile**: [`ShippingProfile`](internal.ShippingProfile.md) - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:15 - -___ - -### profile\_id - -• **profile\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:14 - -___ - -### provider - -• **provider**: [`FulfillmentProvider`](internal.FulfillmentProvider.md) - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:17 - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:16 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:13 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:12 - -___ - -### requirements - -• **requirements**: [`ShippingOptionRequirement`](internal.ShippingOptionRequirement.md)[] - -#### Defined in - -medusa/dist/models/shipping-option.d.ts:22 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md b/www/apps/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md deleted file mode 100644 index 9ca516cf76..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ShippingOptionRequirement.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingOptionRequirement - -[internal](../modules/internal.md).ShippingOptionRequirement - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:11 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:13 - -___ - -### deleted\_at - -• **deleted\_at**: `Date` - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:12 - -___ - -### id - -• **id**: `string` - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:7 - -___ - -### shipping\_option - -• **shipping\_option**: [`ShippingOption`](internal.ShippingOption.md) - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:9 - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:8 - -___ - -### type - -• **type**: [`RequirementType`](../enums/internal.RequirementType.md) - -#### Defined in - -medusa/dist/models/shipping-option-requirement.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/classes/internal.ShippingProfile.md b/www/apps/docs/content/references/js-client/classes/internal.ShippingProfile.md deleted file mode 100644 index 1593640484..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.ShippingProfile.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: ShippingProfile - -[internal](../modules/internal.md).ShippingProfile - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`ShippingProfile`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:15 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:14 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:10 - -___ - -### products - -• **products**: [`Product`](internal.Product.md)[] - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:12 - -___ - -### shipping\_options - -• **shipping\_options**: [`ShippingOption`](internal.ShippingOption.md)[] - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:13 - -___ - -### type - -• **type**: [`ShippingProfileType`](../enums/internal.ShippingProfileType.md) - -#### Defined in - -medusa/dist/models/shipping-profile.d.ts:11 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md b/www/apps/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md deleted file mode 100644 index 31338f7573..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.SoftDeletableEntity.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: SoftDeletableEntity - -[internal](../modules/internal.md).SoftDeletableEntity - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`SoftDeletableEntity`** - - ↳↳ [`Customer`](internal.Customer.md) - - ↳↳ [`Address`](internal.Address.md) - - ↳↳ [`CustomerGroup`](internal.CustomerGroup.md) - - ↳↳ [`Cart`](internal.Cart.md) - - ↳↳ [`Region`](internal.Region.md) - - ↳↳ [`Discount`](internal.Discount.md) - - ↳↳ [`GiftCard`](internal.GiftCard.md) - - ↳↳ [`ClaimOrder`](internal.ClaimOrder.md) - - ↳↳ [`Swap`](internal.Swap.md) - - ↳↳ [`SalesChannel`](internal.SalesChannel.md) - - ↳↳ [`PriceList`](internal.PriceList.md) - - ↳↳ [`DiscountRule`](internal.DiscountRule.md) - - ↳↳ [`ShippingOption`](internal.ShippingOption.md) - - ↳↳ [`TrackingLink`](internal.TrackingLink.md) - - ↳↳ [`ClaimItem`](internal.ClaimItem.md) - - ↳↳ [`OrderItemChange`](internal.OrderItemChange.md) - - ↳↳ [`PaymentCollection`](internal.PaymentCollection.md) - - ↳↳ [`ProductVariant`](internal.ProductVariant.md) - - ↳↳ [`MoneyAmount`](internal.MoneyAmount.md) - - ↳↳ [`Product`](internal.Product.md) - - ↳↳ [`ProductType`](internal.ProductType.md) - - ↳↳ [`DiscountCondition`](internal.DiscountCondition.md) - - ↳↳ [`ShippingProfile`](internal.ShippingProfile.md) - - ↳↳ [`ReturnReason`](internal.ReturnReason.md) - - ↳↳ [`ClaimImage`](internal.ClaimImage.md) - - ↳↳ [`ClaimTag`](internal.ClaimTag.md) - - ↳↳ [`ProductOptionValue`](internal.ProductOptionValue.md) - - ↳↳ [`Image`](internal.Image.md) - - ↳↳ [`ProductOption`](internal.ProductOption.md) - - ↳↳ [`ProductCollection`](internal.ProductCollection.md) - - ↳↳ [`ProductTag`](internal.ProductTag.md) - - ↳↳ [`User`](internal-1.User.md) - - ↳↳ [`BatchJob`](internal-2.BatchJob.md) - - ↳↳ [`Invite`](internal-10.Invite.md) - - ↳↳ [`Note`](internal-11.Note.md) - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md b/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md index b56efd71fc..eb33de8960 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesAddressReq.md @@ -6,6 +6,12 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).StorePostCustomersCustomerAddressesAddressReq +**`Schema`** + +StorePostCustomersCustomerAddressesAddressReq +anyOf: + - $ref: "#/components/schemas/AddressPayload" + ## Hierarchy - [`AddressPayload`](internal.AddressPayload.md) @@ -24,7 +30,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/common.d.ts:96 +packages/medusa/dist/types/common.d.ts:160 ___ @@ -38,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:97 +packages/medusa/dist/types/common.d.ts:161 ___ @@ -52,7 +58,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:98 +packages/medusa/dist/types/common.d.ts:162 ___ @@ -66,7 +72,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:95 +packages/medusa/dist/types/common.d.ts:159 ___ @@ -80,7 +86,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:99 +packages/medusa/dist/types/common.d.ts:163 ___ @@ -94,7 +100,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:91 +packages/medusa/dist/types/common.d.ts:155 ___ @@ -108,13 +114,13 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:92 +packages/medusa/dist/types/common.d.ts:156 ___ ### metadata -• `Optional` **metadata**: `Record`<`string`, `unknown`\> +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> #### Inherited from @@ -122,7 +128,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:94 +packages/medusa/dist/types/common.d.ts:158 ___ @@ -136,7 +142,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:93 +packages/medusa/dist/types/common.d.ts:157 ___ @@ -150,7 +156,7 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:101 +packages/medusa/dist/types/common.d.ts:165 ___ @@ -164,4 +170,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:100 +packages/medusa/dist/types/common.d.ts:164 diff --git a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md b/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md index dba3f2b12d..d7b3d7ef4d 100644 --- a/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md +++ b/www/apps/docs/content/references/js-client/classes/internal.StorePostCustomersCustomerAddressesReq.md @@ -6,6 +6,17 @@ displayed_sidebar: jsClientSidebar [internal](../modules/internal.md).StorePostCustomersCustomerAddressesReq +**`Schema`** + +StorePostCustomersCustomerAddressesReq +type: object +required: + - address +properties: + address: + description: "The Address to add to the Customer's saved addresses." + $ref: "#/components/schemas/AddressCreatePayload" + ## Properties ### address @@ -14,4 +25,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/api/routes/store/customers/create-address.d.ts:99 +packages/medusa/dist/api/routes/store/customers/create-address.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/classes/internal.Swap.md b/www/apps/docs/content/references/js-client/classes/internal.Swap.md deleted file mode 100644 index f7f9e40d31..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.Swap.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: Swap - -[internal](../modules/internal.md).Swap - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`Swap`** - -## Properties - -### additional\_items - -• **additional\_items**: [`LineItem`](internal.LineItem.md)[] - -#### Defined in - -medusa/dist/models/swap.d.ts:34 - -___ - -### allow\_backorder - -• **allow\_backorder**: `boolean` - -#### Defined in - -medusa/dist/models/swap.d.ts:47 - -___ - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/swap.d.ts:50 - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -medusa/dist/models/swap.d.ts:45 - -___ - -### cart - -• **cart**: [`Cart`](internal.Cart.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:43 - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -medusa/dist/models/swap.d.ts:42 - -___ - -### confirmed\_at - -• **confirmed\_at**: `Date` - -#### Defined in - -medusa/dist/models/swap.d.ts:44 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### difference\_due - -• **difference\_due**: `number` - -#### Defined in - -medusa/dist/models/swap.d.ts:38 - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/internal.SwapFulfillmentStatus.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:30 - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](internal.Fulfillment.md)[] - -#### Defined in - -medusa/dist/models/swap.d.ts:36 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/swap.d.ts:48 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/swap.d.ts:49 - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -medusa/dist/models/swap.d.ts:46 - -___ - -### order - -• **order**: [`Order`](internal.Order.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:33 - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -medusa/dist/models/swap.d.ts:32 - -___ - -### payment - -• **payment**: [`Payment`](internal.Payment.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:37 - -___ - -### payment\_status - -• **payment\_status**: [`SwapPaymentStatus`](../enums/internal.SwapPaymentStatus.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:31 - -___ - -### return\_order - -• **return\_order**: [`Return`](internal.Return.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:35 - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](internal.Address.md) - -#### Defined in - -medusa/dist/models/swap.d.ts:40 - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -medusa/dist/models/swap.d.ts:39 - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](internal.ShippingMethod.md)[] - -#### Defined in - -medusa/dist/models/swap.d.ts:41 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.TaxLine.md b/www/apps/docs/content/references/js-client/classes/internal.TaxLine.md deleted file mode 100644 index 96781cfcaa..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.TaxLine.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: TaxLine - -[internal](../modules/internal.md).TaxLine - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`TaxLine`** - - ↳↳ [`ShippingMethodTaxLine`](internal.ShippingMethodTaxLine.md) - - ↳↳ [`LineItemTaxLine`](internal.LineItemTaxLine.md) - -## Properties - -### code - -• **code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/tax-line.d.ts:5 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/tax-line.d.ts:6 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/tax-line.d.ts:4 - -___ - -### rate - -• **rate**: `number` - -#### Defined in - -medusa/dist/models/tax-line.d.ts:3 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.TaxRate.md b/www/apps/docs/content/references/js-client/classes/internal.TaxRate.md deleted file mode 100644 index d3c665b943..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.TaxRate.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: TaxRate - -[internal](../modules/internal.md).TaxRate - -Base abstract entity for all entities - -## Hierarchy - -- [`BaseEntity`](internal.BaseEntity.md) - - ↳ **`TaxRate`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:19 - -___ - -### code - -• **code**: ``null`` \| `string` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:8 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[created_at](internal.BaseEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[id](internal.BaseEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:12 - -___ - -### name - -• **name**: `string` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:9 - -___ - -### product\_count - -• `Optional` **product\_count**: `number` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:16 - -___ - -### product\_type\_count - -• `Optional` **product\_type\_count**: `number` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:17 - -___ - -### product\_types - -• **product\_types**: [`ProductType`](internal.ProductType.md)[] - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:14 - -___ - -### products - -• **products**: [`Product`](internal.Product.md)[] - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:13 - -___ - -### rate - -• **rate**: ``null`` \| `number` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:7 - -___ - -### region - -• **region**: [`Region`](internal.Region.md) - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:11 - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:10 - -___ - -### shipping\_option\_count - -• `Optional` **shipping\_option\_count**: `number` - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:18 - -___ - -### shipping\_options - -• **shipping\_options**: [`ShippingOption`](internal.ShippingOption.md)[] - -#### Defined in - -medusa/dist/models/tax-rate.d.ts:15 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[BaseEntity](internal.BaseEntity.md).[updated_at](internal.BaseEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/classes/internal.TrackingLink.md b/www/apps/docs/content/references/js-client/classes/internal.TrackingLink.md deleted file mode 100644 index 1b4fc2e00c..0000000000 --- a/www/apps/docs/content/references/js-client/classes/internal.TrackingLink.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Class: TrackingLink - -[internal](../modules/internal.md).TrackingLink - -Base abstract entity for all entities - -## Hierarchy - -- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md) - - ↳ **`TrackingLink`** - -## Properties - -### beforeInsert - -• `Private` **beforeInsert**: `any` - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:10 - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:6 - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at) - -#### Defined in - -medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3 - -___ - -### fulfillment - -• **fulfillment**: [`Fulfillment`](internal.Fulfillment.md) - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:7 - -___ - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:6 - -___ - -### id - -• **id**: `string` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:5 - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:8 - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:9 - -___ - -### tracking\_number - -• **tracking\_number**: `string` - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:5 - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at) - -#### Defined in - -medusa/dist/interfaces/models/base-entity.d.ts:7 - -___ - -### url - -• **url**: `string` - -#### Defined in - -medusa/dist/models/tracking-link.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md b/www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md index ba306c053e..2f8f3d5443 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md +++ b/www/apps/docs/content/references/js-client/enums/internal-1.UserRoles.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Enumeration: UserRoles [internal](../modules/internal-1.md).UserRoles @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/models/user.d.ts:3 +packages/medusa/dist/models/user.d.ts:3 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:5 +packages/medusa/dist/models/user.d.ts:5 ___ @@ -30,4 +34,4 @@ ___ #### Defined in -medusa/dist/models/user.d.ts:4 +packages/medusa/dist/models/user.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md b/www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md index 22793e77f2..a3151c11e1 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-2.BatchJobStatus.md @@ -1,3 +1,7 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Enumeration: BatchJobStatus [internal](../modules/internal-2.md).BatchJobStatus @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/types/batch-job.d.ts:9 +packages/medusa/dist/types/batch-job.d.ts:9 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:8 +packages/medusa/dist/types/batch-job.d.ts:8 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:6 +packages/medusa/dist/types/batch-job.d.ts:6 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:4 +packages/medusa/dist/types/batch-job.d.ts:4 ___ @@ -50,7 +54,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:10 +packages/medusa/dist/types/batch-job.d.ts:10 ___ @@ -60,7 +64,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:5 +packages/medusa/dist/types/batch-job.d.ts:5 ___ @@ -70,4 +74,4 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:7 +packages/medusa/dist/types/batch-job.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal.AllocationType.md b/www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md similarity index 58% rename from www/apps/docs/content/references/js-client/enums/internal.AllocationType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md index 36a0a12f17..4e80089ffd 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.AllocationType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.AllocationType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: AllocationType -[internal](../modules/internal.md).AllocationType +[internal](../modules/internal-3.md).AllocationType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/discount-rule.d.ts:10 +packages/medusa/dist/models/discount-rule.d.ts:10 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/discount-rule.d.ts:9 +packages/medusa/dist/models/discount-rule.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal.CartType.md b/www/apps/docs/content/references/js-client/enums/internal-3.CartType.md similarity index 63% rename from www/apps/docs/content/references/js-client/enums/internal.CartType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.CartType.md index 8ecf2803d3..5a3a224d00 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.CartType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.CartType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: CartType -[internal](../modules/internal.md).CartType +[internal](../modules/internal-3.md).CartType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/cart.d.ts:187 +packages/medusa/dist/models/cart.d.ts:248 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/cart.d.ts:183 +packages/medusa/dist/models/cart.d.ts:244 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/cart.d.ts:185 +packages/medusa/dist/models/cart.d.ts:246 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/cart.d.ts:186 +packages/medusa/dist/models/cart.d.ts:247 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/cart.d.ts:184 +packages/medusa/dist/models/cart.d.ts:245 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md similarity index 64% rename from www/apps/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md index 520a55f6ba..cca7c0fa3f 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimFulfillmentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ClaimFulfillmentStatus -[internal](../modules/internal.md).ClaimFulfillmentStatus +[internal](../modules/internal-3.md).ClaimFulfillmentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/claim-order.d.ts:26 +packages/medusa/dist/models/claim-order.d.ts:26 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:21 +packages/medusa/dist/models/claim-order.d.ts:21 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:19 +packages/medusa/dist/models/claim-order.d.ts:19 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:20 +packages/medusa/dist/models/claim-order.d.ts:20 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:24 +packages/medusa/dist/models/claim-order.d.ts:24 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:22 +packages/medusa/dist/models/claim-order.d.ts:22 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:27 +packages/medusa/dist/models/claim-order.d.ts:27 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:25 +packages/medusa/dist/models/claim-order.d.ts:25 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:23 +packages/medusa/dist/models/claim-order.d.ts:23 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md similarity index 60% rename from www/apps/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md index 26903125a4..2b7ad93f24 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimPaymentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ClaimPaymentStatus -[internal](../modules/internal.md).ClaimPaymentStatus +[internal](../modules/internal-3.md).ClaimPaymentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/claim-order.d.ts:14 +packages/medusa/dist/models/claim-order.d.ts:14 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:15 +packages/medusa/dist/models/claim-order.d.ts:15 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:16 +packages/medusa/dist/models/claim-order.d.ts:16 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ClaimReason.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md similarity index 64% rename from www/apps/docs/content/references/js-client/enums/internal.ClaimReason.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md index f3eed9d64b..5cbaef6768 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ClaimReason.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimReason.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ClaimReason -[internal](../modules/internal.md).ClaimReason +[internal](../modules/internal-3.md).ClaimReason ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/claim-item.d.ts:8 +packages/medusa/dist/models/claim-item.d.ts:8 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/claim-item.d.ts:11 +packages/medusa/dist/models/claim-item.d.ts:11 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/claim-item.d.ts:10 +packages/medusa/dist/models/claim-item.d.ts:10 ___ @@ -44,4 +44,4 @@ ___ #### Defined in -medusa/dist/models/claim-item.d.ts:9 +packages/medusa/dist/models/claim-item.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ClaimType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.ClaimType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md index 7719828e6e..818b664463 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ClaimType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ClaimType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ClaimType -[internal](../modules/internal.md).ClaimType +[internal](../modules/internal-3.md).ClaimType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/claim-order.d.ts:10 +packages/medusa/dist/models/claim-order.d.ts:10 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/claim-order.d.ts:11 +packages/medusa/dist/models/claim-order.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md similarity index 56% rename from www/apps/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md rename to www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md index 6b4c61f7a6..22ea480005 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.DiscountConditionOperator.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionOperator.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: DiscountConditionOperator -[internal](../modules/internal.md).DiscountConditionOperator +[internal](../modules/internal-3.md).DiscountConditionOperator ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/discount-condition.d.ts:16 +packages/medusa/dist/models/discount-condition.d.ts:16 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/discount-condition.d.ts:17 +packages/medusa/dist/models/discount-condition.d.ts:17 diff --git a/www/apps/docs/content/references/js-client/enums/internal.DiscountConditionType.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md similarity index 62% rename from www/apps/docs/content/references/js-client/enums/internal.DiscountConditionType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md index 8c84ec5b5b..cf9ea06796 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.DiscountConditionType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountConditionType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: DiscountConditionType -[internal](../modules/internal.md).DiscountConditionType +[internal](../modules/internal-3.md).DiscountConditionType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/discount-condition.d.ts:13 +packages/medusa/dist/models/discount-condition.d.ts:13 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/discount-condition.d.ts:9 +packages/medusa/dist/models/discount-condition.d.ts:9 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/discount-condition.d.ts:11 +packages/medusa/dist/models/discount-condition.d.ts:11 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/discount-condition.d.ts:12 +packages/medusa/dist/models/discount-condition.d.ts:12 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/discount-condition.d.ts:10 +packages/medusa/dist/models/discount-condition.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/enums/internal.DiscountRuleType.md b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.DiscountRuleType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md index 4775574377..c2d37c3c4e 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.DiscountRuleType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.DiscountRuleType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: DiscountRuleType -[internal](../modules/internal.md).DiscountRuleType +[internal](../modules/internal-3.md).DiscountRuleType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/discount-rule.d.ts:4 +packages/medusa/dist/models/discount-rule.d.ts:4 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/discount-rule.d.ts:6 +packages/medusa/dist/models/discount-rule.d.ts:6 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -medusa/dist/models/discount-rule.d.ts:5 +packages/medusa/dist/models/discount-rule.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal.DraftOrderStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md similarity index 60% rename from www/apps/docs/content/references/js-client/enums/internal.DraftOrderStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md index 74b022bc9c..3a1d7ce69d 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.DraftOrderStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.DraftOrderStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: DraftOrderStatus -[internal](../modules/internal.md).DraftOrderStatus +[internal](../modules/internal-3.md).DraftOrderStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/draft-order.d.ts:6 +packages/medusa/dist/models/draft-order.d.ts:6 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/draft-order.d.ts:5 +packages/medusa/dist/models/draft-order.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal.FulfillmentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md similarity index 67% rename from www/apps/docs/content/references/js-client/enums/internal.FulfillmentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md index 82297dab01..3b00060c1f 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.FulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.FulfillmentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: FulfillmentStatus -[internal](../modules/internal.md).FulfillmentStatus +[internal](../modules/internal-3.md).FulfillmentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:36 +packages/medusa/dist/models/order.d.ts:36 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:31 +packages/medusa/dist/models/order.d.ts:31 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:29 +packages/medusa/dist/models/order.d.ts:29 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:30 +packages/medusa/dist/models/order.d.ts:30 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:34 +packages/medusa/dist/models/order.d.ts:34 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:32 +packages/medusa/dist/models/order.d.ts:32 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:37 +packages/medusa/dist/models/order.d.ts:37 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:35 +packages/medusa/dist/models/order.d.ts:35 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:33 +packages/medusa/dist/models/order.d.ts:33 diff --git a/www/apps/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md similarity index 60% rename from www/apps/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md index e59b935ac6..7da0646bbf 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.OrderEditItemChangeType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditItemChangeType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: OrderEditItemChangeType -[internal](../modules/internal.md).OrderEditItemChangeType +[internal](../modules/internal-3.md).OrderEditItemChangeType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order-item-change.d.ts:5 +packages/medusa/dist/models/order-item-change.d.ts:5 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order-item-change.d.ts:6 +packages/medusa/dist/models/order-item-change.d.ts:6 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -medusa/dist/models/order-item-change.d.ts:7 +packages/medusa/dist/models/order-item-change.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal.OrderEditStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.OrderEditStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md index ae6d7daa8c..fae1b0303b 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.OrderEditStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.OrderEditStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: OrderEditStatus -[internal](../modules/internal.md).OrderEditStatus +[internal](../modules/internal-3.md).OrderEditStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order-edit.d.ts:8 +packages/medusa/dist/models/order-edit.d.ts:8 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:4 +packages/medusa/dist/models/order-edit.d.ts:4 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:7 +packages/medusa/dist/models/order-edit.d.ts:7 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:5 +packages/medusa/dist/models/order-edit.d.ts:5 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/order-edit.d.ts:6 +packages/medusa/dist/models/order-edit.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/enums/internal.OrderStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md similarity index 64% rename from www/apps/docs/content/references/js-client/enums/internal.OrderStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md index 2a7cfed4e0..a4ebdff77c 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.OrderStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.OrderStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: OrderStatus -[internal](../modules/internal.md).OrderStatus +[internal](../modules/internal-3.md).OrderStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:24 +packages/medusa/dist/models/order.d.ts:24 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:25 +packages/medusa/dist/models/order.d.ts:25 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:23 +packages/medusa/dist/models/order.d.ts:23 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:22 +packages/medusa/dist/models/order.d.ts:22 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:26 +packages/medusa/dist/models/order.d.ts:26 diff --git a/www/apps/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md similarity index 60% rename from www/apps/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md index 0a2fa20d1c..25a34d6b0d 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.PaymentCollectionStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.PaymentCollectionStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: PaymentCollectionStatus -[internal](../modules/internal.md).PaymentCollectionStatus +[internal](../modules/internal-3.md).PaymentCollectionStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/payment-collection.d.ts:6 +packages/medusa/dist/models/payment-collection.d.ts:6 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:5 +packages/medusa/dist/models/payment-collection.d.ts:5 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:8 +packages/medusa/dist/models/payment-collection.d.ts:8 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:4 +packages/medusa/dist/models/payment-collection.d.ts:4 ___ @@ -54,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/payment-collection.d.ts:7 +packages/medusa/dist/models/payment-collection.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal.PaymentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md similarity index 65% rename from www/apps/docs/content/references/js-client/enums/internal.PaymentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md index 3fbde93965..f078130c87 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.PaymentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.PaymentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: PaymentStatus -[internal](../modules/internal.md).PaymentStatus +[internal](../modules/internal-3.md).PaymentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/order.d.ts:41 +packages/medusa/dist/models/order.d.ts:41 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:45 +packages/medusa/dist/models/order.d.ts:45 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:42 +packages/medusa/dist/models/order.d.ts:42 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:40 +packages/medusa/dist/models/order.d.ts:40 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:43 +packages/medusa/dist/models/order.d.ts:43 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:44 +packages/medusa/dist/models/order.d.ts:44 ___ @@ -74,4 +74,4 @@ ___ #### Defined in -medusa/dist/models/order.d.ts:46 +packages/medusa/dist/models/order.d.ts:46 diff --git a/www/apps/docs/content/references/js-client/enums/internal.PriceListStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.PriceListStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md index 09e4ddc9e9..7579a9c490 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.PriceListStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: PriceListStatus -[internal](../modules/internal.md).PriceListStatus +[internal](../modules/internal-3.md).PriceListStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/price-list.d.ts:8 +packages/medusa/dist/types/price-list.d.ts:8 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:9 +packages/medusa/dist/types/price-list.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/enums/internal.PriceListType.md b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.PriceListType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md index f53290c120..d530bb75bf 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.PriceListType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.PriceListType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: PriceListType -[internal](../modules/internal.md).PriceListType +[internal](../modules/internal-3.md).PriceListType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/types/price-list.d.ts:5 +packages/medusa/dist/types/price-list.d.ts:5 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/types/price-list.d.ts:4 +packages/medusa/dist/types/price-list.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ProductStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md similarity index 62% rename from www/apps/docs/content/references/js-client/enums/internal.ProductStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md index b2ae46e269..175c2ff076 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ProductStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ProductStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ProductStatus -[internal](../modules/internal.md).ProductStatus +[internal](../modules/internal-3.md).ProductStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/product.d.ts:11 +packages/medusa/dist/models/product.d.ts:12 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/product.d.ts:12 +packages/medusa/dist/models/product.d.ts:13 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/product.d.ts:13 +packages/medusa/dist/models/product.d.ts:14 ___ @@ -44,4 +44,4 @@ ___ #### Defined in -medusa/dist/models/product.d.ts:14 +packages/medusa/dist/models/product.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/enums/internal.RequirementType.md b/www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md similarity index 59% rename from www/apps/docs/content/references/js-client/enums/internal.RequirementType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md index d182fdcf7d..16995f5310 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.RequirementType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.RequirementType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: RequirementType -[internal](../modules/internal.md).RequirementType +[internal](../modules/internal-3.md).RequirementType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/shipping-option-requirement.d.ts:4 +packages/medusa/dist/models/shipping-option-requirement.d.ts:4 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/shipping-option-requirement.d.ts:3 +packages/medusa/dist/models/shipping-option-requirement.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ReturnStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md similarity index 64% rename from www/apps/docs/content/references/js-client/enums/internal.ReturnStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md index 705558ef55..1cfef96dfd 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ReturnStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ReturnStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ReturnStatus -[internal](../modules/internal.md).ReturnStatus +[internal](../modules/internal-3.md).ReturnStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/return.d.ts:11 +packages/medusa/dist/models/return.d.ts:11 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/return.d.ts:9 +packages/medusa/dist/models/return.d.ts:9 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/return.d.ts:8 +packages/medusa/dist/models/return.d.ts:8 ___ @@ -44,4 +44,4 @@ ___ #### Defined in -medusa/dist/models/return.d.ts:10 +packages/medusa/dist/models/return.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md similarity index 61% rename from www/apps/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md index 532ca4aa9d..4d24f57447 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingOptionPriceType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ShippingOptionPriceType -[internal](../modules/internal.md).ShippingOptionPriceType +[internal](../modules/internal-3.md).ShippingOptionPriceType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/shipping-option.d.ts:8 +packages/medusa/dist/models/shipping-option.d.ts:8 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa/dist/models/shipping-option.d.ts:7 +packages/medusa/dist/models/shipping-option.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/enums/internal.ShippingProfileType.md b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md similarity index 59% rename from www/apps/docs/content/references/js-client/enums/internal.ShippingProfileType.md rename to www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md index d232a74207..2ef2ae7e7c 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.ShippingProfileType.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.ShippingProfileType.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: ShippingProfileType -[internal](../modules/internal.md).ShippingProfileType +[internal](../modules/internal-3.md).ShippingProfileType ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/shipping-profile.d.ts:7 +packages/medusa/dist/models/shipping-profile.d.ts:7 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/shipping-profile.d.ts:5 +packages/medusa/dist/models/shipping-profile.d.ts:5 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -medusa/dist/models/shipping-profile.d.ts:6 +packages/medusa/dist/models/shipping-profile.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md similarity index 66% rename from www/apps/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md index daf462612b..3efec69e7d 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.SwapFulfillmentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: SwapFulfillmentStatus -[internal](../modules/internal.md).SwapFulfillmentStatus +[internal](../modules/internal-3.md).SwapFulfillmentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/swap.d.ts:15 +packages/medusa/dist/models/swap.d.ts:15 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:12 +packages/medusa/dist/models/swap.d.ts:12 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:11 +packages/medusa/dist/models/swap.d.ts:11 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:14 +packages/medusa/dist/models/swap.d.ts:14 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:16 +packages/medusa/dist/models/swap.d.ts:16 ___ @@ -64,4 +64,4 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:13 +packages/medusa/dist/models/swap.d.ts:13 diff --git a/www/apps/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md similarity index 66% rename from www/apps/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md rename to www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md index 2c0f8ba7ad..1846f66ddb 100644 --- a/www/apps/docs/content/references/js-client/enums/internal.SwapPaymentStatus.md +++ b/www/apps/docs/content/references/js-client/enums/internal-3.SwapPaymentStatus.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Enumeration: SwapPaymentStatus -[internal](../modules/internal.md).SwapPaymentStatus +[internal](../modules/internal-3.md).SwapPaymentStatus ## Enumeration Members @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa/dist/models/swap.d.ts:20 +packages/medusa/dist/models/swap.d.ts:20 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:23 +packages/medusa/dist/models/swap.d.ts:23 ___ @@ -34,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:21 +packages/medusa/dist/models/swap.d.ts:21 ___ @@ -44,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:22 +packages/medusa/dist/models/swap.d.ts:22 ___ @@ -54,7 +54,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:24 +packages/medusa/dist/models/swap.d.ts:24 ___ @@ -64,7 +64,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:19 +packages/medusa/dist/models/swap.d.ts:19 ___ @@ -74,7 +74,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:25 +packages/medusa/dist/models/swap.d.ts:25 ___ @@ -84,7 +84,7 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:26 +packages/medusa/dist/models/swap.d.ts:26 ___ @@ -94,4 +94,4 @@ ___ #### Defined in -medusa/dist/models/swap.d.ts:27 +packages/medusa/dist/models/swap.d.ts:27 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md b/www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md new file mode 100644 index 0000000000..b0243f88d6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.DefaultPriceType.md @@ -0,0 +1,13 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DefaultPriceType + +[internal](../modules/internal-8.md).DefaultPriceType + +## References + +### DEFAULT + +Re-exports [DEFAULT](../modules/internal-8.md#default) diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md b/www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md new file mode 100644 index 0000000000..c55e311c32 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.DiscountConditionJoinTableForeignKey.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: DiscountConditionJoinTableForeignKey + +[internal](../modules/internal-8.md).DiscountConditionJoinTableForeignKey + +## Enumeration Members + +### CUSTOMER\_GROUP\_ID + +• **CUSTOMER\_GROUP\_ID** = ``"customer_group_id"`` + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:8 + +___ + +### PRODUCT\_COLLECTION\_ID + +• **PRODUCT\_COLLECTION\_ID** = ``"product_collection_id"`` + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:6 + +___ + +### PRODUCT\_ID + +• **PRODUCT\_ID** = ``"product_id"`` + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:4 + +___ + +### PRODUCT\_TAG\_ID + +• **PRODUCT\_TAG\_ID** = ``"product_tag_id"`` + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:7 + +___ + +### PRODUCT\_TYPE\_ID + +• **PRODUCT\_TYPE\_ID** = ``"product_type_id"`` + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md new file mode 100644 index 0000000000..ce3b64a280 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.FulfillmentStatus.md @@ -0,0 +1,97 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: FulfillmentStatus + +[internal](../modules/internal-8.md).FulfillmentStatus + +## Enumeration Members + +### canceled + +• **canceled** = ``"canceled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:23 + +___ + +### fulfilled + +• **fulfilled** = ``"fulfilled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:19 + +___ + +### not\_fulfilled + +• **not\_fulfilled** = ``"not_fulfilled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:18 + +___ + +### partially\_fulfilled + +• **partially\_fulfilled** = ``"partially_fulfilled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:20 + +___ + +### partially\_returned + +• **partially\_returned** = ``"partially_returned"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:25 + +___ + +### partially\_shipped + +• **partially\_shipped** = ``"partially_shipped"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:22 + +___ + +### requires\_action + +• **requires\_action** = ``"requires_action"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:26 + +___ + +### returned + +• **returned** = ``"returned"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:24 + +___ + +### shipped + +• **shipped** = ``"shipped"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:21 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md b/www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md new file mode 100644 index 0000000000..514cc1c9bd --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.MODULE_RESOURCE_TYPE.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: MODULE\_RESOURCE\_TYPE + +[internal](../modules/internal-8.md).MODULE_RESOURCE_TYPE + +## Enumeration Members + +### ISOLATED + +• **ISOLATED** = ``"isolated"`` + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:15 + +___ + +### SHARED + +• **SHARED** = ``"shared"`` + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md b/www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md new file mode 100644 index 0000000000..95f9c8e530 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.OrderStatus.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: OrderStatus + +[internal](../modules/internal-8.md).OrderStatus + +## Enumeration Members + +### archived + +• **archived** = ``"archived"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:13 + +___ + +### canceled + +• **canceled** = ``"canceled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:14 + +___ + +### completed + +• **completed** = ``"completed"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:12 + +___ + +### pending + +• **pending** = ``"pending"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:11 + +___ + +### requires\_action + +• **requires\_action** = ``"requires_action"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md b/www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md new file mode 100644 index 0000000000..9a2afd70a8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.PaymentStatus.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PaymentStatus + +[internal](../modules/internal-8.md).PaymentStatus + +## Enumeration Members + +### awaiting + +• **awaiting** = ``"awaiting"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:30 + +___ + +### canceled + +• **canceled** = ``"canceled"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:34 + +___ + +### captured + +• **captured** = ``"captured"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:29 + +___ + +### not\_paid + +• **not\_paid** = ``"not_paid"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:31 + +___ + +### partially\_refunded + +• **partially\_refunded** = ``"partially_refunded"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:33 + +___ + +### refunded + +• **refunded** = ``"refunded"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:32 + +___ + +### requires\_action + +• **requires\_action** = ``"requires_action"`` + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:35 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md new file mode 100644 index 0000000000..a081f71987 --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentCollectionType.md @@ -0,0 +1,13 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PaymentCollectionType + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentCollectionType + +## References + +### ORDER\_EDIT + +Re-exports [ORDER_EDIT](../modules/internal-3.md#order_edit) diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md new file mode 100644 index 0000000000..5dd60497fc --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PaymentSessionStatus.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PaymentSessionStatus + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentSessionStatus + +## Enumeration Members + +### AUTHORIZED + +• **AUTHORIZED** = ``"authorized"`` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:4 + +___ + +### CANCELED + +• **CANCELED** = ``"canceled"`` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:8 + +___ + +### ERROR + +• **ERROR** = ``"error"`` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:7 + +___ + +### PENDING + +• **PENDING** = ``"pending"`` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:5 + +___ + +### REQUIRES\_MORE + +• **REQUIRES\_MORE** = ``"requires_more"`` + +#### Defined in + +packages/medusa/dist/models/payment-session.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md new file mode 100644 index 0000000000..3ca1ccb7ae --- /dev/null +++ b/www/apps/docs/content/references/js-client/enums/internal-8.internal.PostgresError.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Enumeration: PostgresError + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PostgresError + +## Enumeration Members + +### DUPLICATE\_ERROR + +• **DUPLICATE\_ERROR** = ``"23505"`` + +#### Defined in + +packages/medusa/dist/utils/exception-formatter.d.ts:3 + +___ + +### FOREIGN\_KEY\_ERROR + +• **FOREIGN\_KEY\_ERROR** = ``"23503"`` + +#### Defined in + +packages/medusa/dist/utils/exception-formatter.d.ts:4 + +___ + +### NULL\_VIOLATION + +• **NULL\_VIOLATION** = ``"23502"`` + +#### Defined in + +packages/medusa/dist/utils/exception-formatter.d.ts:6 + +___ + +### SERIALIZATION\_FAILURE + +• **SERIALIZATION\_FAILURE** = ``"40001"`` + +#### Defined in + +packages/medusa/dist/utils/exception-formatter.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/enums/internal-16.RefundReason.md b/www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md similarity index 51% rename from www/apps/docs/content/references/js-client/enums/internal-16.RefundReason.md rename to www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md index 7b2e3053c1..5541e49d22 100644 --- a/www/apps/docs/content/references/js-client/enums/internal-16.RefundReason.md +++ b/www/apps/docs/content/references/js-client/enums/internal-8.internal.RefundReason.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # Enumeration: RefundReason -[internal](../modules/internal-16.md).RefundReason +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).RefundReason ## Enumeration Members @@ -10,7 +14,7 @@ #### Defined in -medusa/dist/models/refund.d.ts:8 +packages/medusa/dist/models/refund.d.ts:8 ___ @@ -20,7 +24,7 @@ ___ #### Defined in -medusa/dist/models/refund.d.ts:5 +packages/medusa/dist/models/refund.d.ts:5 ___ @@ -30,7 +34,7 @@ ___ #### Defined in -medusa/dist/models/refund.d.ts:9 +packages/medusa/dist/models/refund.d.ts:9 ___ @@ -40,7 +44,7 @@ ___ #### Defined in -medusa/dist/models/refund.d.ts:6 +packages/medusa/dist/models/refund.d.ts:6 ___ @@ -50,4 +54,4 @@ ___ #### Defined in -medusa/dist/models/refund.d.ts:7 +packages/medusa/dist/models/refund.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/index.md b/www/apps/docs/content/references/js-client/index.md index 4e1a6d6a5b..56cf3544ed 100644 --- a/www/apps/docs/content/references/js-client/index.md +++ b/www/apps/docs/content/references/js-client/index.md @@ -1,6 +1,10 @@ +--- +displayed_sidebar: jsClientSidebar +--- + # JS Client Reference -## Namespaces +## Modules - [internal](modules/internal.md) - [internal](modules/internal-1.md) @@ -15,45 +19,6 @@ - [internal](modules/internal-10.md) - [internal](modules/internal-11.md) - [internal](modules/internal-12.md) -- [internal](modules/internal-13.md) -- [internal](modules/internal-14.md) -- [internal](modules/internal-15.md) -- [internal](modules/internal-16.md) -- [internal](modules/internal-17.md) -- [internal](modules/internal-18.md) -- [internal](modules/internal-19.md) -- [internal](modules/internal-20.md) -- [internal](modules/internal-21.md) -- [internal](modules/internal-22.md) -- [internal](modules/internal-23.md) -- [internal](modules/internal-24.md) -- [internal](modules/internal-25.md) -- [internal](modules/internal-26.md) -- [internal](modules/internal-27.md) -- [internal](modules/internal-28.md) -- [internal](modules/internal-29.md) -- [internal](modules/internal-30.md) -- [internal](modules/internal-31.md) -- [internal](modules/internal-32.md) -- [internal](modules/internal-33.md) -- [internal](modules/internal-34.md) -- [internal](modules/internal-35.md) -- [internal](modules/internal-36.md) -- [internal](modules/internal-37.md) -- [internal](modules/internal-38.md) -- [internal](modules/internal-39.md) -- [internal](modules/internal-40.md) -- [internal](modules/internal-41.md) -- [internal](modules/internal-42.md) -- [internal](modules/internal-43.md) -- [internal](modules/internal-44.md) -- [internal](modules/internal-45.md) -- [internal](modules/internal-46.md) -- [internal](modules/internal-47.md) -- [internal](modules/internal-48.md) -- [internal](modules/internal-49.md) -- [internal](modules/internal-50.md) -- [internal](modules/internal-51.md) ## Classes @@ -63,11 +28,13 @@ - [AdminBatchJobsResource](classes/AdminBatchJobsResource.md) - [AdminCollectionsResource](classes/AdminCollectionsResource.md) - [AdminCurrenciesResource](classes/AdminCurrenciesResource.md) +- [AdminCustomResource](classes/AdminCustomResource.md) - [AdminCustomerGroupsResource](classes/AdminCustomerGroupsResource.md) - [AdminCustomersResource](classes/AdminCustomersResource.md) - [AdminDiscountsResource](classes/AdminDiscountsResource.md) - [AdminDraftOrdersResource](classes/AdminDraftOrdersResource.md) - [AdminGiftCardsResource](classes/AdminGiftCardsResource.md) +- [AdminInventoryItemsResource](classes/AdminInventoryItemsResource.md) - [AdminInvitesResource](classes/AdminInvitesResource.md) - [AdminNotesResource](classes/AdminNotesResource.md) - [AdminNotificationsResource](classes/AdminNotificationsResource.md) @@ -76,16 +43,19 @@ - [AdminPaymentCollectionsResource](classes/AdminPaymentCollectionsResource.md) - [AdminPaymentsResource](classes/AdminPaymentsResource.md) - [AdminPriceListResource](classes/AdminPriceListResource.md) +- [AdminProductCategoriesResource](classes/AdminProductCategoriesResource.md) - [AdminProductTagsResource](classes/AdminProductTagsResource.md) - [AdminProductTypesResource](classes/AdminProductTypesResource.md) - [AdminProductsResource](classes/AdminProductsResource.md) - [AdminPublishableApiKeyResource](classes/AdminPublishableApiKeyResource.md) - [AdminRegionsResource](classes/AdminRegionsResource.md) +- [AdminReservationsResource](classes/AdminReservationsResource.md) - [AdminReturnReasonsResource](classes/AdminReturnReasonsResource.md) - [AdminReturnsResource](classes/AdminReturnsResource.md) - [AdminSalesChannelsResource](classes/AdminSalesChannelsResource.md) - [AdminShippingOptionsResource](classes/AdminShippingOptionsResource.md) - [AdminShippingProfilesResource](classes/AdminShippingProfilesResource.md) +- [AdminStockLocationsResource](classes/AdminStockLocationsResource.md) - [AdminStoresResource](classes/AdminStoresResource.md) - [AdminSwapsResource](classes/AdminSwapsResource.md) - [AdminTaxRatesResource](classes/AdminTaxRatesResource.md) @@ -102,6 +72,8 @@ - [OrdersResource](classes/OrdersResource.md) - [PaymentCollectionsResource](classes/PaymentCollectionsResource.md) - [PaymentMethodsResource](classes/PaymentMethodsResource.md) +- [ProductCategoriesResource](classes/ProductCategoriesResource.md) +- [ProductTagsResource](classes/ProductTagsResource.md) - [ProductTypesResource](classes/ProductTypesResource.md) - [ProductVariantsResource](classes/ProductVariantsResource.md) - [ProductsResource](classes/ProductsResource.md) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md new file mode 100644 index 0000000000..9865c1dfe2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.BlobPropertyBag.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: BlobPropertyBag + +[internal](../modules/internal-10.md).BlobPropertyBag + +## Hierarchy + +- **`BlobPropertyBag`** + + ↳ [`FilePropertyBag`](internal-10.FilePropertyBag.md) + +## Properties + +### endings + +• `Optional` **endings**: [`EndingType`](../modules/internal-10.md#endingtype) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:172 + +___ + +### type + +• `Optional` **type**: `string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:173 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.File.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.File.md new file mode 100644 index 0000000000..d642be5d89 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.File.md @@ -0,0 +1,187 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: File + +[internal](../modules/internal-10.md).File + +Provides information about files and allows JavaScript in a web page to access their content. + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/File) + +## Hierarchy + +- `Blob` + + ↳ **`File`** + +## Properties + +### lastModified + +• `Readonly` **lastModified**: `number` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/File/lastModified) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:8262 + +___ + +### name + +• `Readonly` **name**: `string` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/File/name) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:8264 + +___ + +### prototype + +• **prototype**: `Blob` + +#### Inherited from + +Blob.prototype + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3124 + +___ + +### size + +• `Readonly` **size**: `number` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/size) + +#### Inherited from + +Blob.size + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3110 + +___ + +### type + +• `Readonly` **type**: `string` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/type) + +#### Inherited from + +Blob.type + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3112 + +___ + +### webkitRelativePath + +• `Readonly` **webkitRelativePath**: `string` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/File/webkitRelativePath) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:8266 + +## Methods + +### arrayBuffer + +▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) + +#### Returns + +`Promise`<`ArrayBuffer`\> + +#### Inherited from + +Blob.arrayBuffer + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3114 + +___ + +### slice + +▸ **slice**(`start?`, `end?`, `contentType?`): `Blob` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `start?` | `number` | +| `end?` | `number` | +| `contentType?` | `string` | + +#### Returns + +`Blob` + +#### Inherited from + +Blob.slice + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3116 + +___ + +### stream + +▸ **stream**(): [`ReadableStream`](../modules/internal-10.md#readablestream)<`Uint8Array`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) + +#### Returns + +[`ReadableStream`](../modules/internal-10.md#readablestream)<`Uint8Array`\> + +#### Inherited from + +Blob.stream + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3118 + +___ + +### text + +▸ **text**(): `Promise`<`string`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) + +#### Returns + +`Promise`<`string`\> + +#### Inherited from + +Blob.text + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:3120 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md new file mode 100644 index 0000000000..e6b370ed1a --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.FilePropertyBag.md @@ -0,0 +1,51 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FilePropertyBag + +[internal](../modules/internal-10.md).FilePropertyBag + +## Hierarchy + +- [`BlobPropertyBag`](internal-10.BlobPropertyBag.md) + + ↳ **`FilePropertyBag`** + +## Properties + +### endings + +• `Optional` **endings**: [`EndingType`](../modules/internal-10.md#endingtype) + +#### Inherited from + +[BlobPropertyBag](internal-10.BlobPropertyBag.md).[endings](internal-10.BlobPropertyBag.md#endings) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:172 + +___ + +### lastModified + +• `Optional` **lastModified**: `number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:514 + +___ + +### type + +• `Optional` **type**: `string` + +#### Inherited from + +[BlobPropertyBag](internal-10.BlobPropertyBag.md).[type](internal-10.BlobPropertyBag.md#type) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:173 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md new file mode 100644 index 0000000000..53c90619ca --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategy.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: QueuingStrategy + +[internal](../modules/internal-10.md).QueuingStrategy + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Properties + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1298 + +___ + +### size + +• `Optional` **size**: [`QueuingStrategySize`](internal-10.QueuingStrategySize.md)<`T`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1299 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md new file mode 100644 index 0000000000..7892c1a3d2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.QueuingStrategySize.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: QueuingStrategySize + +[internal](../modules/internal-10.md).QueuingStrategySize + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Callable + +### QueuingStrategySize + +▸ **QueuingStrategySize**(`chunk`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `T` | + +#### Returns + +`number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26838 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md new file mode 100644 index 0000000000..bd86c62e76 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableByteStreamController.md @@ -0,0 +1,93 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableByteStreamController + +[internal](../modules/internal-10.md).ReadableByteStreamController + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController) + +## Properties + +### byobRequest + +• `Readonly` **byobRequest**: ``null`` \| [`ReadableStreamBYOBRequest`](../modules/internal-10.md#readablestreambyobrequest) + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/byobRequest) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18466 + +___ + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/desiredSize) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18468 + +## Methods + +### close + +▸ **close**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18470 + +___ + +### enqueue + +▸ **enqueue**(`chunk`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | [`ArrayBufferView`](internal-8.ArrayBufferView.md) | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18472 + +___ + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18474 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md new file mode 100644 index 0000000000..c1e2df47a4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStream.md @@ -0,0 +1,168 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStream + +[internal](../modules/internal-10.md).ReadableStream + +This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream) + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### locked + +• `Readonly` **locked**: `boolean` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/locked) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18489 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18491 + +___ + +### getReader + +▸ **getReader**(`options`): [`ReadableStreamBYOBReader`](../modules/internal-10.md#readablestreambyobreader) + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | `Object` | +| `options.mode` | ``"byob"`` | + +#### Returns + +[`ReadableStreamBYOBReader`](../modules/internal-10.md#readablestreambyobreader) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18493 + +▸ **getReader**(): [`ReadableStreamDefaultReader`](../modules/internal-10.md#readablestreamdefaultreader)<`R`\> + +#### Returns + +[`ReadableStreamDefaultReader`](../modules/internal-10.md#readablestreamdefaultreader)<`R`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18494 + +▸ **getReader**(`options?`): [`ReadableStreamReader`](../modules/internal-10.md#readablestreamreader)<`R`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | [`ReadableStreamGetReaderOptions`](internal-10.ReadableStreamGetReaderOptions.md) | + +#### Returns + +[`ReadableStreamReader`](../modules/internal-10.md#readablestreamreader)<`R`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18495 + +___ + +### pipeThrough + +▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../modules/internal-10.md#readablestream)<`T`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transform` | [`ReadableWritablePair`](internal-10.ReadableWritablePair.md)<`T`, `R`\> | +| `options?` | [`StreamPipeOptions`](internal-10.StreamPipeOptions.md) | + +#### Returns + +[`ReadableStream`](../modules/internal-10.md#readablestream)<`T`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18497 + +___ + +### pipeTo + +▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | [`WritableStream`](../modules/internal-10.md#writablestream)<`R`\> | +| `options?` | [`StreamPipeOptions`](internal-10.StreamPipeOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18499 + +___ + +### tee + +▸ **tee**(): [[`ReadableStream`](../modules/internal-10.md#readablestream)<`R`\>, [`ReadableStream`](../modules/internal-10.md#readablestream)<`R`\>] + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) + +#### Returns + +[[`ReadableStream`](../modules/internal-10.md#readablestream)<`R`\>, [`ReadableStream`](../modules/internal-10.md#readablestream)<`R`\>] + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18501 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md new file mode 100644 index 0000000000..d328032879 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBReader.md @@ -0,0 +1,101 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamBYOBReader + +[internal](../modules/internal-10.md).ReadableStreamBYOBReader + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader) + +## Hierarchy + +- [`ReadableStreamGenericReader`](internal-10.ReadableStreamGenericReader.md) + + ↳ **`ReadableStreamBYOBReader`** + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) + +#### Inherited from + +[ReadableStreamGenericReader](internal-10.ReadableStreamGenericReader.md).[closed](internal-10.ReadableStreamGenericReader.md#closed) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18571 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ReadableStreamGenericReader](internal-10.ReadableStreamGenericReader.md).[cancel](internal-10.ReadableStreamGenericReader.md#cancel) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18573 + +___ + +### read + +▸ **read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../modules/internal-10.md#readablestreamreadresult)<`T`\>\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`ArrayBufferView`](internal-8.ArrayBufferView.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `view` | `T` | + +#### Returns + +`Promise`<[`ReadableStreamReadResult`](../modules/internal-10.md#readablestreamreadresult)<`T`\>\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18514 + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18516 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md new file mode 100644 index 0000000000..6cc7c62681 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamBYOBRequest.md @@ -0,0 +1,65 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamBYOBRequest + +[internal](../modules/internal-10.md).ReadableStreamBYOBRequest + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest) + +## Properties + +### view + +• `Readonly` **view**: ``null`` \| [`ArrayBufferView`](internal-8.ArrayBufferView.md) + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/view) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18527 + +## Methods + +### respond + +▸ **respond**(`bytesWritten`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `bytesWritten` | `number` | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18529 + +___ + +### respondWithNewView + +▸ **respondWithNewView**(`view`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `view` | [`ArrayBufferView`](internal-8.ArrayBufferView.md) | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18531 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md new file mode 100644 index 0000000000..39600488b4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultController.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultController + +[internal](../modules/internal-10.md).ReadableStreamDefaultController + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController) + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/desiredSize) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18542 + +## Methods + +### close + +▸ **close**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18544 + +___ + +### enqueue + +▸ **enqueue**(`chunk?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk?` | `R` | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18546 + +___ + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18548 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md new file mode 100644 index 0000000000..f84b79a06d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamDefaultReader.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultReader + +[internal](../modules/internal-10.md).ReadableStreamDefaultReader + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader) + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Hierarchy + +- [`ReadableStreamGenericReader`](internal-10.ReadableStreamGenericReader.md) + + ↳ **`ReadableStreamDefaultReader`** + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) + +#### Inherited from + +[ReadableStreamGenericReader](internal-10.ReadableStreamGenericReader.md).[closed](internal-10.ReadableStreamGenericReader.md#closed) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18571 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ReadableStreamGenericReader](internal-10.ReadableStreamGenericReader.md).[cancel](internal-10.ReadableStreamGenericReader.md#cancel) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18573 + +___ + +### read + +▸ **read**(): `Promise`<[`ReadableStreamReadResult`](../modules/internal-10.md#readablestreamreadresult)<`R`\>\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) + +#### Returns + +`Promise`<[`ReadableStreamReadResult`](../modules/internal-10.md#readablestreamreadresult)<`R`\>\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18559 + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18561 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md new file mode 100644 index 0000000000..b0d3a6ce34 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGenericReader.md @@ -0,0 +1,49 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamGenericReader + +[internal](../modules/internal-10.md).ReadableStreamGenericReader + +## Hierarchy + +- **`ReadableStreamGenericReader`** + + ↳ [`ReadableStreamBYOBReader`](internal-10.ReadableStreamBYOBReader.md) + + ↳ [`ReadableStreamDefaultReader`](internal-10.ReadableStreamDefaultReader.md) + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/closed) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18571 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18573 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md new file mode 100644 index 0000000000..2254db6dd3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamGetReaderOptions.md @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamGetReaderOptions + +[internal](../modules/internal-10.md).ReadableStreamGetReaderOptions + +## Properties + +### mode + +• `Optional` **mode**: ``"byob"`` + +Creates a ReadableStreamBYOBReader and locks the stream to the new reader. + +This call behaves the same way as the no-argument variant, except that it only works on readable byte streams, i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading. The returned BYOB reader provides the ability to directly read individual chunks from the stream via its read() method, into developer-supplied buffers, allowing more precise control over allocation. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1638 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md new file mode 100644 index 0000000000..ca59614596 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadDoneResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamReadDoneResult + +[internal](../modules/internal-10.md).ReadableStreamReadDoneResult + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Properties + +### done + +• **done**: ``true`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1642 + +___ + +### value + +• `Optional` **value**: `T` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1643 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md new file mode 100644 index 0000000000..39c8c920e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableStreamReadValueResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamReadValueResult + +[internal](../modules/internal-10.md).ReadableStreamReadValueResult + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Properties + +### done + +• **done**: ``false`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1647 + +___ + +### value + +• **value**: `T` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1648 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md new file mode 100644 index 0000000000..3e07994968 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.ReadableWritablePair.md @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableWritablePair + +[internal](../modules/internal-10.md).ReadableWritablePair + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | +| `W` | `any` | + +## Properties + +### readable + +• **readable**: [`ReadableStream`](../modules/internal-10.md#readablestream)<`R`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1652 + +___ + +### writable + +• **writable**: [`WritableStream`](../modules/internal-10.md#writablestream)<`W`\> + +Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use. + +Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1658 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md new file mode 100644 index 0000000000..36c69fdaf7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.StreamPipeOptions.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: StreamPipeOptions + +[internal](../modules/internal-10.md).StreamPipeOptions + +## Properties + +### preventAbort + +• `Optional` **preventAbort**: `boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1833 + +___ + +### preventCancel + +• `Optional` **preventCancel**: `boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1834 + +___ + +### preventClose + +• `Optional` **preventClose**: `boolean` + +Pipes this readable stream to a given writable stream destination. The way in which the piping process behaves under various error conditions can be customized with a number of passed options. It returns a promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered. + +Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader. + +Errors and closures of the source and destination streams propagate as follows: + +An error in this source readable stream will abort destination, unless preventAbort is truthy. The returned promise will be rejected with the source's error, or with any error that occurs during aborting the destination. + +An error in destination will cancel this source readable stream, unless preventCancel is truthy. The returned promise will be rejected with the destination's error, or with any error that occurs during canceling the source. + +When this source readable stream closes, destination will be closed, unless preventClose is truthy. The returned promise will be fulfilled once this process completes, unless an error is encountered while closing the destination, in which case it will be rejected with that error. + +If destination starts out closed or closing, this source readable stream will be canceled, unless preventCancel is true. The returned promise will be rejected with an error indicating piping to a closed stream failed, or with any error that occurs during canceling the source. + +The signal option can be set to an AbortSignal to allow aborting an ongoing pipe operation via the corresponding AbortController. In this case, this source readable stream will be canceled, and destination aborted, unless the respective options preventCancel or preventAbort are set. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1852 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1853 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md new file mode 100644 index 0000000000..ce66e4df88 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingByteSource.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingByteSource + +[internal](../modules/internal-10.md).UnderlyingByteSource + +## Properties + +### autoAllocateChunkSize + +• `Optional` **autoAllocateChunkSize**: `number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1938 + +___ + +### cancel + +• `Optional` **cancel**: [`UnderlyingSourceCancelCallback`](internal-10.UnderlyingSourceCancelCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1939 + +___ + +### pull + +• `Optional` **pull**: (`controller`: [`ReadableByteStreamController`](../modules/internal-10.md#readablebytestreamcontroller)) => `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Type declaration + +▸ (`controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableByteStreamController`](../modules/internal-10.md#readablebytestreamcontroller) | + +##### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1940 + +___ + +### start + +• `Optional` **start**: (`controller`: [`ReadableByteStreamController`](../modules/internal-10.md#readablebytestreamcontroller)) => `any` + +#### Type declaration + +▸ (`controller`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableByteStreamController`](../modules/internal-10.md#readablebytestreamcontroller) | + +##### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1941 + +___ + +### type + +• **type**: ``"bytes"`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1942 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md new file mode 100644 index 0000000000..56843fcd16 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingDefaultSource.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingDefaultSource + +[internal](../modules/internal-10.md).UnderlyingDefaultSource + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### cancel + +• `Optional` **cancel**: [`UnderlyingSourceCancelCallback`](internal-10.UnderlyingSourceCancelCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1946 + +___ + +### pull + +• `Optional` **pull**: (`controller`: [`ReadableStreamDefaultController`](../modules/internal-10.md#readablestreamdefaultcontroller)<`R`\>) => `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Type declaration + +▸ (`controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamDefaultController`](../modules/internal-10.md#readablestreamdefaultcontroller)<`R`\> | + +##### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1947 + +___ + +### start + +• `Optional` **start**: (`controller`: [`ReadableStreamDefaultController`](../modules/internal-10.md#readablestreamdefaultcontroller)<`R`\>) => `any` + +#### Type declaration + +▸ (`controller`): `any` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamDefaultController`](../modules/internal-10.md#readablestreamdefaultcontroller)<`R`\> | + +##### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1948 + +___ + +### type + +• `Optional` **type**: `undefined` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1949 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md new file mode 100644 index 0000000000..f243ae6bf8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSink.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSink + +[internal](../modules/internal-10.md).UnderlyingSink + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### abort + +• `Optional` **abort**: [`UnderlyingSinkAbortCallback`](internal-10.UnderlyingSinkAbortCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1953 + +___ + +### close + +• `Optional` **close**: [`UnderlyingSinkCloseCallback`](internal-10.UnderlyingSinkCloseCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1954 + +___ + +### start + +• `Optional` **start**: [`UnderlyingSinkStartCallback`](internal-10.UnderlyingSinkStartCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1955 + +___ + +### type + +• `Optional` **type**: `undefined` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1956 + +___ + +### write + +• `Optional` **write**: [`UnderlyingSinkWriteCallback`](internal-10.UnderlyingSinkWriteCallback.md)<`W`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1957 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md new file mode 100644 index 0000000000..e840f0b2ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkAbortCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkAbortCallback + +[internal](../modules/internal-10.md).UnderlyingSinkAbortCallback + +## Callable + +### UnderlyingSinkAbortCallback + +▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26874 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md new file mode 100644 index 0000000000..e11fd5b40c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkCloseCallback.md @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkCloseCallback + +[internal](../modules/internal-10.md).UnderlyingSinkCloseCallback + +## Callable + +### UnderlyingSinkCloseCallback + +▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26878 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md new file mode 100644 index 0000000000..34e4d14bfd --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkStartCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkStartCallback + +[internal](../modules/internal-10.md).UnderlyingSinkStartCallback + +## Callable + +### UnderlyingSinkStartCallback + +▸ **UnderlyingSinkStartCallback**(`controller`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`WritableStreamDefaultController`](../modules/internal-10.md#writablestreamdefaultcontroller) | + +#### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26882 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md new file mode 100644 index 0000000000..fb3be1f057 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSinkWriteCallback.md @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkWriteCallback + +[internal](../modules/internal-10.md).UnderlyingSinkWriteCallback + +## Type parameters + +| Name | +| :------ | +| `W` | + +## Callable + +### UnderlyingSinkWriteCallback + +▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `W` | +| `controller` | [`WritableStreamDefaultController`](../modules/internal-10.md#writablestreamdefaultcontroller) | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26886 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md new file mode 100644 index 0000000000..e047ece30f --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSource.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSource + +[internal](../modules/internal-10.md).UnderlyingSource + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### autoAllocateChunkSize + +• `Optional` **autoAllocateChunkSize**: `number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1961 + +___ + +### cancel + +• `Optional` **cancel**: [`UnderlyingSourceCancelCallback`](internal-10.UnderlyingSourceCancelCallback.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1962 + +___ + +### pull + +• `Optional` **pull**: [`UnderlyingSourcePullCallback`](internal-10.UnderlyingSourcePullCallback.md)<`R`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1963 + +___ + +### start + +• `Optional` **start**: [`UnderlyingSourceStartCallback`](internal-10.UnderlyingSourceStartCallback.md)<`R`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1964 + +___ + +### type + +• `Optional` **type**: ``"bytes"`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:1965 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md new file mode 100644 index 0000000000..b6ec279c67 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceCancelCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourceCancelCallback + +[internal](../modules/internal-10.md).UnderlyingSourceCancelCallback + +## Callable + +### UnderlyingSourceCancelCallback + +▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26890 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md new file mode 100644 index 0000000000..47c060c20b --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourcePullCallback.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourcePullCallback + +[internal](../modules/internal-10.md).UnderlyingSourcePullCallback + +## Type parameters + +| Name | +| :------ | +| `R` | + +## Callable + +### UnderlyingSourcePullCallback + +▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamController`](../modules/internal-10.md#readablestreamcontroller)<`R`\> | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26894 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md new file mode 100644 index 0000000000..4f6467106e --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.UnderlyingSourceStartCallback.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourceStartCallback + +[internal](../modules/internal-10.md).UnderlyingSourceStartCallback + +## Type parameters + +| Name | +| :------ | +| `R` | + +## Callable + +### UnderlyingSourceStartCallback + +▸ **UnderlyingSourceStartCallback**(`controller`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamController`](../modules/internal-10.md#readablestreamcontroller)<`R`\> | + +#### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26898 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md new file mode 100644 index 0000000000..75a8b273ab --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStream.md @@ -0,0 +1,83 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStream + +[internal](../modules/internal-10.md).WritableStream + +This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing. + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream) + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### locked + +• `Readonly` **locked**: `boolean` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/locked) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26022 + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26024 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26026 + +___ + +### getWriter + +▸ **getWriter**(): [`WritableStreamDefaultWriter`](../modules/internal-10.md#writablestreamdefaultwriter)<`W`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) + +#### Returns + +[`WritableStreamDefaultWriter`](../modules/internal-10.md#writablestreamdefaultwriter)<`W`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26028 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md new file mode 100644 index 0000000000..2d9f329a3d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultController.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStreamDefaultController + +[internal](../modules/internal-10.md).WritableStreamDefaultController + +This Streams API interface represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate. + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController) + +## Properties + +### signal + +• `Readonly` **signal**: `AbortSignal` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/signal) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26043 + +## Methods + +### error + +▸ **error**(`e?`): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26045 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md new file mode 100644 index 0000000000..dc9aec6505 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-10.WritableStreamDefaultWriter.md @@ -0,0 +1,129 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStreamDefaultWriter + +[internal](../modules/internal-10.md).WritableStreamDefaultWriter + +This Streams API interface is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink. + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter) + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/closed) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26060 + +___ + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/desiredSize) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26062 + +___ + +### ready + +• `Readonly` **ready**: `Promise`<`undefined`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/ready) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26064 + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26066 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26068 + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) + +#### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26070 + +___ + +### write + +▸ **write**(`chunk?`): `Promise`<`void`\> + +[MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk?` | `W` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26072 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md new file mode 100644 index 0000000000..1b98da8347 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosAdapter.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosAdapter + +[internal](../modules/internal-12.md).AxiosAdapter + +## Callable + +### AxiosAdapter + +▸ **AxiosAdapter**(`config`): [`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `AxiosRequestConfig`<`any`\> | + +#### Returns + +[`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:18 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md similarity index 57% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md index eeb5f4899e..39307fc479 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosBasicCredentials.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosBasicCredentials.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosBasicCredentials -[internal](../modules/internal.md).AxiosBasicCredentials +[internal](../modules/internal-12.md).AxiosBasicCredentials ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:23 +packages/medusa-js/node_modules/axios/index.d.ts:23 ___ @@ -24,4 +24,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:22 +packages/medusa-js/node_modules/axios/index.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md similarity index 63% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md index f38e5e12e5..69e00b1bbe 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosDefaults.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosDefaults.md @@ -4,7 +4,9 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosDefaults -[internal](../modules/internal.md).AxiosDefaults +[internal](../modules/internal-12.md).AxiosDefaults + +Construct a type with the properties of T except for those in type K. ## Type parameters @@ -14,7 +16,7 @@ displayed_sidebar: jsClientSidebar ## Hierarchy -- `Omit`<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\>, ``"headers"``\> +- [`Omit`](../modules/internal-1.md#omit)<`AxiosRequestConfig`<`D`\>, ``"headers"``\> ↳ **`AxiosDefaults`** @@ -22,7 +24,7 @@ displayed_sidebar: jsClientSidebar ### adapter -• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md) +• `Optional` **adapter**: [`AxiosAdapter`](internal-12.AxiosAdapter.md) #### Inherited from @@ -30,13 +32,13 @@ Omit.adapter #### Defined in -medusa-js/node_modules/axios/index.d.ts:75 +packages/medusa-js/node_modules/axios/index.d.ts:75 ___ ### auth -• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md) +• `Optional` **auth**: [`AxiosBasicCredentials`](internal-12.AxiosBasicCredentials.md) #### Inherited from @@ -44,7 +46,7 @@ Omit.auth #### Defined in -medusa-js/node_modules/axios/index.d.ts:76 +packages/medusa-js/node_modules/axios/index.d.ts:76 ___ @@ -58,13 +60,13 @@ Omit.baseURL #### Defined in -medusa-js/node_modules/axios/index.d.ts:65 +packages/medusa-js/node_modules/axios/index.d.ts:65 ___ ### cancelToken -• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md) +• `Optional` **cancelToken**: [`CancelToken`](internal-12.CancelToken.md) #### Inherited from @@ -72,7 +74,7 @@ Omit.cancelToken #### Defined in -medusa-js/node_modules/axios/index.d.ts:90 +packages/medusa-js/node_modules/axios/index.d.ts:90 ___ @@ -86,7 +88,7 @@ Omit.data #### Defined in -medusa-js/node_modules/axios/index.d.ts:71 +packages/medusa-js/node_modules/axios/index.d.ts:71 ___ @@ -100,17 +102,17 @@ Omit.decompress #### Defined in -medusa-js/node_modules/axios/index.d.ts:91 +packages/medusa-js/node_modules/axios/index.d.ts:91 ___ ### headers -• **headers**: [`HeadersDefaults`](internal.HeadersDefaults.md) +• **headers**: [`HeadersDefaults`](internal-12.HeadersDefaults.md) #### Defined in -medusa-js/node_modules/axios/index.d.ts:112 +packages/medusa-js/node_modules/axios/index.d.ts:112 ___ @@ -124,7 +126,7 @@ Omit.httpAgent #### Defined in -medusa-js/node_modules/axios/index.d.ts:87 +packages/medusa-js/node_modules/axios/index.d.ts:87 ___ @@ -138,7 +140,7 @@ Omit.httpsAgent #### Defined in -medusa-js/node_modules/axios/index.d.ts:88 +packages/medusa-js/node_modules/axios/index.d.ts:88 ___ @@ -152,7 +154,7 @@ Omit.insecureHTTPParser #### Defined in -medusa-js/node_modules/axios/index.d.ts:94 +packages/medusa-js/node_modules/axios/index.d.ts:94 ___ @@ -166,7 +168,7 @@ Omit.maxBodyLength #### Defined in -medusa-js/node_modules/axios/index.d.ts:84 +packages/medusa-js/node_modules/axios/index.d.ts:84 ___ @@ -180,7 +182,7 @@ Omit.maxContentLength #### Defined in -medusa-js/node_modules/axios/index.d.ts:82 +packages/medusa-js/node_modules/axios/index.d.ts:82 ___ @@ -194,13 +196,13 @@ Omit.maxRedirects #### Defined in -medusa-js/node_modules/axios/index.d.ts:85 +packages/medusa-js/node_modules/axios/index.d.ts:85 ___ ### method -• `Optional` **method**: [`Method`](../modules/internal.md#method) +• `Optional` **method**: [`Method`](../modules/internal-12.md#method) #### Inherited from @@ -208,7 +210,7 @@ Omit.method #### Defined in -medusa-js/node_modules/axios/index.d.ts:64 +packages/medusa-js/node_modules/axios/index.d.ts:64 ___ @@ -236,7 +238,7 @@ Omit.onDownloadProgress #### Defined in -medusa-js/node_modules/axios/index.d.ts:81 +packages/medusa-js/node_modules/axios/index.d.ts:81 ___ @@ -264,7 +266,7 @@ Omit.onUploadProgress #### Defined in -medusa-js/node_modules/axios/index.d.ts:80 +packages/medusa-js/node_modules/axios/index.d.ts:80 ___ @@ -278,7 +280,7 @@ Omit.params #### Defined in -medusa-js/node_modules/axios/index.d.ts:69 +packages/medusa-js/node_modules/axios/index.d.ts:69 ___ @@ -306,13 +308,13 @@ Omit.paramsSerializer #### Defined in -medusa-js/node_modules/axios/index.d.ts:70 +packages/medusa-js/node_modules/axios/index.d.ts:70 ___ ### proxy -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md) +• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal-12.AxiosProxyConfig.md) #### Inherited from @@ -320,13 +322,13 @@ Omit.proxy #### Defined in -medusa-js/node_modules/axios/index.d.ts:89 +packages/medusa-js/node_modules/axios/index.d.ts:89 ___ ### raxConfig -• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md) +• `Optional` **raxConfig**: [`RetryConfig`](internal-12.RetryConfig.md) #### Inherited from @@ -334,13 +336,13 @@ Omit.raxConfig #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 ___ ### responseType -• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype) +• `Optional` **responseType**: [`ResponseType`](../modules/internal-12.md#responsetype) #### Inherited from @@ -348,7 +350,7 @@ Omit.responseType #### Defined in -medusa-js/node_modules/axios/index.d.ts:77 +packages/medusa-js/node_modules/axios/index.d.ts:77 ___ @@ -362,7 +364,7 @@ Omit.signal #### Defined in -medusa-js/node_modules/axios/index.d.ts:93 +packages/medusa-js/node_modules/axios/index.d.ts:93 ___ @@ -376,7 +378,7 @@ Omit.socketPath #### Defined in -medusa-js/node_modules/axios/index.d.ts:86 +packages/medusa-js/node_modules/axios/index.d.ts:86 ___ @@ -390,7 +392,7 @@ Omit.timeout #### Defined in -medusa-js/node_modules/axios/index.d.ts:72 +packages/medusa-js/node_modules/axios/index.d.ts:72 ___ @@ -404,13 +406,13 @@ Omit.timeoutErrorMessage #### Defined in -medusa-js/node_modules/axios/index.d.ts:73 +packages/medusa-js/node_modules/axios/index.d.ts:73 ___ ### transformRequest -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[] +• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal-12.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal-12.AxiosRequestTransformer.md)[] #### Inherited from @@ -418,13 +420,13 @@ Omit.transformRequest #### Defined in -medusa-js/node_modules/axios/index.d.ts:66 +packages/medusa-js/node_modules/axios/index.d.ts:66 ___ ### transformResponse -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[] +• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal-12.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal-12.AxiosResponseTransformer.md)[] #### Inherited from @@ -432,13 +434,13 @@ Omit.transformResponse #### Defined in -medusa-js/node_modules/axios/index.d.ts:67 +packages/medusa-js/node_modules/axios/index.d.ts:67 ___ ### transitional -• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md) +• `Optional` **transitional**: [`TransitionalOptions`](internal-12.TransitionalOptions.md) #### Inherited from @@ -446,7 +448,7 @@ Omit.transitional #### Defined in -medusa-js/node_modules/axios/index.d.ts:92 +packages/medusa-js/node_modules/axios/index.d.ts:92 ___ @@ -460,7 +462,7 @@ Omit.url #### Defined in -medusa-js/node_modules/axios/index.d.ts:63 +packages/medusa-js/node_modules/axios/index.d.ts:63 ___ @@ -474,7 +476,7 @@ Omit.validateStatus #### Defined in -medusa-js/node_modules/axios/index.d.ts:83 +packages/medusa-js/node_modules/axios/index.d.ts:83 ___ @@ -488,7 +490,7 @@ Omit.withCredentials #### Defined in -medusa-js/node_modules/axios/index.d.ts:74 +packages/medusa-js/node_modules/axios/index.d.ts:74 ___ @@ -502,7 +504,7 @@ Omit.xsrfCookieName #### Defined in -medusa-js/node_modules/axios/index.d.ts:78 +packages/medusa-js/node_modules/axios/index.d.ts:78 ___ @@ -516,4 +518,4 @@ Omit.xsrfHeaderName #### Defined in -medusa-js/node_modules/axios/index.d.ts:79 +packages/medusa-js/node_modules/axios/index.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md new file mode 100644 index 0000000000..fad7c65a13 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosError.md @@ -0,0 +1,130 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosError + +[internal](../modules/internal-12.md).AxiosError + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `D` | `any` | + +## Hierarchy + +- [`Error`](../modules/internal-8.md#error) + + ↳ **`AxiosError`** + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:126 + +___ + +### config + +• **config**: `AxiosRequestConfig`<`D`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:125 + +___ + +### isAxiosError + +• **isAxiosError**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:129 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### request + +• `Optional` **request**: `any` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:127 + +___ + +### response + +• `Optional` **response**: [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `D`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:128 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### toJSON + +• **toJSON**: () => `object` + +#### Type declaration + +▸ (): `object` + +##### Returns + +`object` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:130 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md new file mode 100644 index 0000000000..b28d4d04c2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInstance.md @@ -0,0 +1,377 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosInstance + +[internal](../modules/internal-12.md).AxiosInstance + +## Hierarchy + +- [`Axios`](../classes/internal-12.Axios.md) + + ↳ **`AxiosInstance`** + +## Callable + +### AxiosInstance + +▸ **AxiosInstance**(`config`): [`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `AxiosRequestConfig`<`any`\> | + +#### Returns + +[`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:188 + +### AxiosInstance + +▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | `AxiosRequestConfig`<`any`\> | + +#### Returns + +[`AxiosPromise`](internal-12.AxiosPromise.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:189 + +## Properties + +### defaults + +• **defaults**: [`AxiosDefaults`](internal-12.AxiosDefaults.md)<`any`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[defaults](../classes/internal-12.Axios.md#defaults) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:171 + +___ + +### interceptors + +• **interceptors**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `request` | [`AxiosInterceptorManager`](internal-12.AxiosInterceptorManager.md)<`AxiosRequestConfig`<`any`\>\> | +| `response` | [`AxiosInterceptorManager`](internal-12.AxiosInterceptorManager.md)<[`AxiosResponse`](internal-12.AxiosResponse.md)<`any`, `any`\>\> | + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[interceptors](../classes/internal-12.Axios.md#interceptors) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:172 + +## Methods + +### delete + +▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[delete](../classes/internal-12.Axios.md#delete) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:179 + +___ + +### get + +▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[get](../classes/internal-12.Axios.md#get) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:178 + +___ + +### getUri + +▸ **getUri**(`config?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config?` | `AxiosRequestConfig`<`any`\> | + +#### Returns + +`string` + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[getUri](../classes/internal-12.Axios.md#geturi) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:176 + +___ + +### head + +▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[head](../classes/internal-12.Axios.md#head) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:180 + +___ + +### options + +▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[options](../classes/internal-12.Axios.md#options) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:181 + +___ + +### patch + +▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[patch](../classes/internal-12.Axios.md#patch) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:184 + +___ + +### post + +▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[post](../classes/internal-12.Axios.md#post) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:182 + +___ + +### put + +▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `url` | `string` | +| `data?` | `D` | +| `config?` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[put](../classes/internal-12.Axios.md#put) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:183 + +___ + +### request + +▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | +| `R` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `D` | `any` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `config` | `AxiosRequestConfig`<`D`\> | + +#### Returns + +`Promise`<`R`\> + +#### Inherited from + +[Axios](../classes/internal-12.Axios.md).[request](../classes/internal-12.Axios.md#request) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:177 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md similarity index 79% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md index c4d4e53445..569b8ffe78 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosInterceptorManager.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosInterceptorManager.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosInterceptorManager -[internal](../modules/internal.md).AxiosInterceptorManager +[internal](../modules/internal-12.md).AxiosInterceptorManager ## Type parameters @@ -30,7 +30,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:166 +packages/medusa-js/node_modules/axios/index.d.ts:166 ___ @@ -57,4 +57,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:165 +packages/medusa-js/node_modules/axios/index.d.ts:165 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md new file mode 100644 index 0000000000..db57800135 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosPromise.md @@ -0,0 +1,132 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AxiosPromise + +[internal](../modules/internal-12.md).AxiosPromise + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Hierarchy + +- `Promise`<[`AxiosResponse`](internal-12.AxiosResponse.md)<`T`\>\> + + ↳ **`AxiosPromise`** + +## Properties + +### [toStringTag] + +• `Readonly` **[toStringTag]**: `string` + +#### Inherited from + +Promise.[toStringTag] + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:176 + +## Methods + +### catch + +▸ **catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> + +Attaches a callback for only the rejection of the Promise. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TResult` | `never` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TResult`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +`Promise`<[`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> \| `TResult`\> + +A Promise for the completion of the callback. + +#### Inherited from + +Promise.catch + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1549 + +___ + +### finally + +▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\>\> + +Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The +resolved value cannot be modified from the callback. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). | + +#### Returns + +`Promise`<[`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\>\> + +A Promise for the completion of the callback. + +#### Inherited from + +Promise.finally + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.promise.d.ts:29 + +___ + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TResult1` | [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\> | +| `TResult2` | `never` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `onfulfilled?` | ``null`` \| (`value`: [`AxiosResponse`](internal-12.AxiosResponse.md)<`T`, `any`\>) => `TResult1` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +`Promise`<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Inherited from + +Promise.then + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1542 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md similarity index 63% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md index 0b5ea3c7c6..2ceb1e37bd 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosProxyConfig.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosProxyConfig.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosProxyConfig -[internal](../modules/internal.md).AxiosProxyConfig +[internal](../modules/internal-12.md).AxiosProxyConfig ## Properties @@ -21,7 +21,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:29 +packages/medusa-js/node_modules/axios/index.d.ts:29 ___ @@ -31,7 +31,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:27 +packages/medusa-js/node_modules/axios/index.d.ts:27 ___ @@ -41,7 +41,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:28 +packages/medusa-js/node_modules/axios/index.d.ts:28 ___ @@ -51,4 +51,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:33 +packages/medusa-js/node_modules/axios/index.d.ts:33 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md similarity index 59% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md index 693fb1de2d..43dcdd350f 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestTransformer.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosRequestTransformer.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosRequestTransformer -[internal](../modules/internal.md).AxiosRequestTransformer +[internal](../modules/internal-12.md).AxiosRequestTransformer ## Callable @@ -17,7 +17,7 @@ displayed_sidebar: jsClientSidebar | Name | Type | | :------ | :------ | | `data` | `any` | -| `headers?` | [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) | +| `headers?` | [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) | #### Returns @@ -25,4 +25,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:10 +packages/medusa-js/node_modules/axios/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponse.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md similarity index 50% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponse.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md index 2c702796d1..090e4a4d91 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponse.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponse.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosResponse -[internal](../modules/internal.md).AxiosResponse +[internal](../modules/internal-12.md).AxiosResponse ## Type parameters @@ -17,11 +17,11 @@ displayed_sidebar: jsClientSidebar ### config -• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> +• **config**: `AxiosRequestConfig`<`D`\> #### Defined in -medusa-js/node_modules/axios/index.d.ts:120 +packages/medusa-js/node_modules/axios/index.d.ts:120 ___ @@ -31,17 +31,17 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:116 +packages/medusa-js/node_modules/axios/index.d.ts:116 ___ ### headers -• **headers**: [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders) +• **headers**: [`AxiosResponseHeaders`](../modules/internal-12.md#axiosresponseheaders) #### Defined in -medusa-js/node_modules/axios/index.d.ts:119 +packages/medusa-js/node_modules/axios/index.d.ts:119 ___ @@ -51,7 +51,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:121 +packages/medusa-js/node_modules/axios/index.d.ts:121 ___ @@ -61,7 +61,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:117 +packages/medusa-js/node_modules/axios/index.d.ts:117 ___ @@ -71,4 +71,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:118 +packages/medusa-js/node_modules/axios/index.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md similarity index 59% rename from www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md index fd9b0a700d..bb811e97b3 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosResponseTransformer.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.AxiosResponseTransformer.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: AxiosResponseTransformer -[internal](../modules/internal.md).AxiosResponseTransformer +[internal](../modules/internal-12.md).AxiosResponseTransformer ## Callable @@ -17,7 +17,7 @@ displayed_sidebar: jsClientSidebar | Name | Type | | :------ | :------ | | `data` | `any` | -| `headers?` | [`AxiosResponseHeaders`](../modules/internal.md#axiosresponseheaders) | +| `headers?` | [`AxiosResponseHeaders`](../modules/internal-12.md#axiosresponseheaders) | #### Returns @@ -25,4 +25,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:14 +packages/medusa-js/node_modules/axios/index.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.Cancel.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md similarity index 58% rename from www/apps/docs/content/references/js-client/interfaces/internal.Cancel.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md index 150d71e073..29e9413eb0 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.Cancel.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.Cancel.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: Cancel -[internal](../modules/internal.md).Cancel +[internal](../modules/internal-12.md).Cancel ## Properties @@ -14,4 +14,4 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:141 +packages/medusa-js/node_modules/axios/index.d.ts:141 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md new file mode 100644 index 0000000000..3bd946ff9e --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.CancelToken.md @@ -0,0 +1,41 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CancelToken + +[internal](../modules/internal-12.md).CancelToken + +## Properties + +### promise + +• **promise**: `Promise`<[`Cancel`](internal-12.Cancel.md)\> + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:154 + +___ + +### reason + +• `Optional` **reason**: [`Cancel`](internal-12.Cancel.md) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:155 + +## Methods + +### throwIfRequested + +▸ **throwIfRequested**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:156 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md new file mode 100644 index 0000000000..afde80977c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.Config.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Config + +[internal](../modules/internal-12.md).Config + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` + +#### Defined in + +[packages/medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L18) + +___ + +### baseUrl + +• **baseUrl**: `string` + +#### Defined in + +[packages/medusa-js/src/request.ts:16](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L16) + +___ + +### customHeaders + +• `Optional` **customHeaders**: [`Record`](../modules/internal.md#record)<`string`, `any`\> + +#### Defined in + +[packages/medusa-js/src/request.ts:20](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L20) + +___ + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L17) + +___ + +### publishableApiKey + +• `Optional` **publishableApiKey**: `string` + +#### Defined in + +[packages/medusa-js/src/request.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L19) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md new file mode 100644 index 0000000000..9e6c2f05d0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.HTTPResponse.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: HTTPResponse + +[internal](../modules/internal-12.md).HTTPResponse + +## Properties + +### config + +• **config**: `any` + +#### Defined in + +[packages/medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L13) + +___ + +### headers + +• **headers**: [`Record`](../modules/internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } + +#### Defined in + +[packages/medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L10) + +___ + +### request + +• `Optional` **request**: `any` + +#### Defined in + +[packages/medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L14) + +___ + +### status + +• **status**: `number` + +#### Defined in + +[packages/medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L8) + +___ + +### statusText + +• **statusText**: `string` + +#### Defined in + +[packages/medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L9) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md new file mode 100644 index 0000000000..8a30be6231 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.HeadersDefaults.md @@ -0,0 +1,117 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: HeadersDefaults + +[internal](../modules/internal-12.md).HeadersDefaults + +## Properties + +### common + +• **common**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:98 + +___ + +### delete + +• **delete**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:99 + +___ + +### get + +• **get**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:100 + +___ + +### head + +• **head**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:101 + +___ + +### link + +• `Optional` **link**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:107 + +___ + +### options + +• `Optional` **options**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:105 + +___ + +### patch + +• **patch**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:104 + +___ + +### post + +• **post**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:102 + +___ + +### purge + +• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:106 + +___ + +### put + +• **put**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:103 + +___ + +### unlink + +• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/internal-12.md#axiosrequestheaders) + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:108 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.RetryConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md similarity index 65% rename from www/apps/docs/content/references/js-client/interfaces/internal.RetryConfig.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md index 261c917c6c..717868ff27 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.RetryConfig.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.RetryConfig.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: RetryConfig -[internal](../modules/internal.md).RetryConfig +[internal](../modules/internal-12.md).RetryConfig Configuration for the Axios `request` method. @@ -18,7 +18,7 @@ Backoff Type; 'linear', 'static' or 'exponential'. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:47 ___ @@ -30,7 +30,7 @@ Whether to check for 'Retry-After' header in response and use value as delay. De #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:51 ___ @@ -42,7 +42,7 @@ The number of retries already attempted. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:13 ___ @@ -55,19 +55,19 @@ Defaults to ['GET','PUT','HEAD','OPTIONS','DELETE'] #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:26 ___ ### instance -• `Optional` **instance**: [`AxiosInstance`](internal.AxiosInstance.md) +• `Optional` **instance**: [`AxiosInstance`](internal-12.AxiosInstance.md) The instance of the axios object to which the interceptor is attached. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:21 ___ @@ -79,7 +79,7 @@ Max permitted Retry-After value (in ms) - rejects if greater. Defaults to 5 mins #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:55 ___ @@ -91,7 +91,7 @@ Ceiling for calculated delay (in ms) - delay will not exceed this value. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:59 ___ @@ -103,13 +103,13 @@ When there is no response, the number of retries to attempt. Defaults to 2. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:43 ___ ### onRetryAttempt -• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `void` +• `Optional` **onRetryAttempt**: (`err`: [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\>) => `void` #### Type declaration @@ -121,7 +121,7 @@ Function to invoke when a retry attempt is made. | Name | Type | | :------ | :------ | -| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | +| `err` | [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\> | ##### Returns @@ -129,7 +129,7 @@ Function to invoke when a retry attempt is made. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:35 ___ @@ -141,7 +141,7 @@ The number of times to retry the request. Defaults to 3. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:9 ___ @@ -153,13 +153,13 @@ The amount of time to initially delay the retry. Defaults to 100. #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:17 ___ ### shouldRetry -• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal.AxiosError.md)<`any`, `any`\>) => `boolean` +• `Optional` **shouldRetry**: (`err`: [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\>) => `boolean` #### Type declaration @@ -171,7 +171,7 @@ Function to invoke which determines if you should retry | Name | Type | | :------ | :------ | -| `err` | [`AxiosError`](internal.AxiosError.md)<`any`, `any`\> | +| `err` | [`AxiosError`](internal-12.AxiosError.md)<`any`, `any`\> | ##### Returns @@ -179,7 +179,7 @@ Function to invoke which determines if you should retry #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:39 ___ @@ -192,4 +192,4 @@ Defaults to: [[100, 199], [429, 429], [500, 599]] #### Defined in -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31 +packages/medusa-js/node_modules/retry-axios/dist/src/index.d.ts:31 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md similarity index 63% rename from www/apps/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md rename to www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md index 2907abad62..5226b997aa 100644 --- a/www/apps/docs/content/references/js-client/interfaces/internal.TransitionalOptions.md +++ b/www/apps/docs/content/references/js-client/interfaces/internal-12.TransitionalOptions.md @@ -4,7 +4,7 @@ displayed_sidebar: jsClientSidebar # Interface: TransitionalOptions -[internal](../modules/internal.md).TransitionalOptions +[internal](../modules/internal-12.md).TransitionalOptions ## Properties @@ -14,7 +14,7 @@ displayed_sidebar: jsClientSidebar #### Defined in -medusa-js/node_modules/axios/index.d.ts:59 +packages/medusa-js/node_modules/axios/index.d.ts:59 ___ @@ -24,7 +24,7 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:58 +packages/medusa-js/node_modules/axios/index.d.ts:58 ___ @@ -34,4 +34,4 @@ ___ #### Defined in -medusa-js/node_modules/axios/index.d.ts:57 +packages/medusa-js/node_modules/axios/index.d.ts:57 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md b/www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md new file mode 100644 index 0000000000..c0edb89380 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-3.Boolean.md @@ -0,0 +1,23 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Boolean + +[internal](../modules/internal-3.md).Boolean + +## Methods + +### valueOf + +▸ **valueOf**(): `boolean` + +Returns the primitive value of the specified object. + +#### Returns + +`boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:548 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md new file mode 100644 index 0000000000..042202fdd9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-5.RequestOptions.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: RequestOptions + +[internal](../modules/internal-5.md).RequestOptions + +## Properties + +### numberOfRetries + +• `Optional` **numberOfRetries**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L25) + +___ + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/medusa-js/src/request.ts:24](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L24) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md new file mode 100644 index 0000000000..f165e575df --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayBufferView.md @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ArrayBufferView + +[internal](../modules/internal-8.md).ArrayBufferView + +## Properties + +### buffer + +• **buffer**: [`ArrayBufferLike`](../modules/internal-8.md#arraybufferlike) + +The ArrayBuffer instance referenced by the array. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1714 + +___ + +### byteLength + +• **byteLength**: `number` + +The length in bytes of the array. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1719 + +___ + +### byteOffset + +• **byteOffset**: `number` + +The offset in bytes of the array. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1724 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md new file mode 100644 index 0000000000..edd3d60f3d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ArrayLike.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ArrayLike + +[internal](../modules/internal-8.md).ArrayLike + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Indexable + +▪ [n: `number`]: `T` + +## Properties + +### length + +• `Readonly` **length**: `number` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1564 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md new file mode 100644 index 0000000000..be5d6f5bd4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGenerator.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AsyncGenerator + +[internal](../modules/internal-8.md).AsyncGenerator + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | +| `TReturn` | `any` | +| `TNext` | `unknown` | + +## Hierarchy + +- [`AsyncIterator`](internal-8.AsyncIterator.md)<`T`, `TReturn`, `TNext`\> + + ↳ **`AsyncGenerator`** + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncGenerator`](internal-8.AsyncGenerator.md)<`T`, `TReturn`, `TNext`\> + +#### Returns + +[`AsyncGenerator`](internal-8.AsyncGenerator.md)<`T`, `TReturn`, `TNext`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:26 + +___ + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`TNext`] | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Overrides + +[AsyncIterator](internal-8.AsyncIterator.md).[next](internal-8.AsyncIterator.md#next) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:23 + +___ + +### return + +▸ **return**(`value`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `TReturn` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TReturn`\> | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Overrides + +[AsyncIterator](internal-8.AsyncIterator.md).[return](internal-8.AsyncIterator.md#return) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:24 + +___ + +### throw + +▸ **throw**(`e`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e` | `any` | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Overrides + +[AsyncIterator](internal-8.AsyncIterator.md).[throw](internal-8.AsyncIterator.md#throw) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md new file mode 100644 index 0000000000..208e6a3399 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncGeneratorFunction.md @@ -0,0 +1,65 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AsyncGeneratorFunction + +[internal](../modules/internal-8.md).AsyncGeneratorFunction + +## Callable + +### AsyncGeneratorFunction + +▸ **AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](internal-8.AsyncGenerator.md)<`unknown`, `any`, `unknown`\> + +Creates a new AsyncGenerator object. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `...args` | `any`[] | A list of arguments the function accepts. | + +#### Returns + +[`AsyncGenerator`](internal-8.AsyncGenerator.md)<`unknown`, `any`, `unknown`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:39 + +## Properties + +### length + +• `Readonly` **length**: `number` + +The length of the arguments. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:43 + +___ + +### name + +• `Readonly` **name**: `string` + +Returns the name of the function. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:47 + +___ + +### prototype + +• `Readonly` **prototype**: [`AsyncGenerator`](internal-8.AsyncGenerator.md)<`unknown`, `any`, `unknown`\> + +A reference to the prototype. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asyncgenerator.d.ts:51 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md new file mode 100644 index 0000000000..10c6d9b1ce --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterable.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AsyncIterable + +[internal](../modules/internal-8.md).AsyncIterable + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterator`](internal-8.AsyncIterator.md)<`T`, `any`, `undefined`\> + +#### Returns + +[`AsyncIterator`](internal-8.AsyncIterator.md)<`T`, `any`, `undefined`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:38 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md new file mode 100644 index 0000000000..dc8fc078cf --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterableIterator.md @@ -0,0 +1,105 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AsyncIterableIterator + +[internal](../modules/internal-8.md).AsyncIterableIterator + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Hierarchy + +- [`AsyncIterator`](internal-8.AsyncIterator.md)<`T`\> + + ↳ **`AsyncIterableIterator`** + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`T`\> + +#### Returns + +[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`T`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:42 + +___ + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`undefined`] | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Inherited from + +[AsyncIterator](internal-8.AsyncIterator.md).[next](internal-8.AsyncIterator.md#next) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:32 + +___ + +### return + +▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `any` | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Inherited from + +[AsyncIterator](internal-8.AsyncIterator.md).[return](internal-8.AsyncIterator.md#return) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33 + +___ + +### throw + +▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\>\> + +#### Inherited from + +[AsyncIterator](internal-8.AsyncIterator.md).[throw](internal-8.AsyncIterator.md#throw) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md new file mode 100644 index 0000000000..07fa23e8e8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.AsyncIterator.md @@ -0,0 +1,83 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: AsyncIterator + +[internal](../modules/internal-8.md).AsyncIterator + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `TReturn` | `any` | +| `TNext` | `undefined` | + +## Hierarchy + +- **`AsyncIterator`** + + ↳ [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md) + + ↳ [`AsyncGenerator`](internal-8.AsyncGenerator.md) + +## Methods + +### next + +▸ **next**(`...args`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`TNext`] | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:32 + +___ + +### return + +▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `TReturn` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TReturn`\> | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:33 + +___ + +### throw + +▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`Promise`<[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\>\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:34 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md new file mode 100644 index 0000000000..e9b273fd21 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.BlobOptions.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: BlobOptions + +[internal](../modules/internal-8.md).BlobOptions + +## Properties + +### encoding + +• `Optional` **encoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +**`Default`** + +```ts +'utf8' +``` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:124 + +___ + +### type + +• `Optional` **type**: `string` + +The Blob content-type. The intent is for `type` to convey +the MIME media type of the data, however no validation of the type format +is performed. + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:130 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md new file mode 100644 index 0000000000..3fa9e8240d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Buffer.md @@ -0,0 +1,4086 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Buffer + +[internal](../modules/internal-8.md).Buffer + +## Hierarchy + +- `Uint8Array` + + ↳ **`Buffer`** + +## Properties + +### BYTES\_PER\_ELEMENT + +• `Readonly` **BYTES\_PER\_ELEMENT**: `number` + +The size in bytes of each element in the array. + +#### Inherited from + +Uint8Array.BYTES\_PER\_ELEMENT + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2151 + +___ + +### [toStringTag] + +• `Readonly` **[toStringTag]**: ``"Uint8Array"`` + +#### Inherited from + +Uint8Array.[toStringTag] + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:284 + +___ + +### buffer + +• `Readonly` **buffer**: [`ArrayBufferLike`](../modules/internal-8.md#arraybufferlike) + +The ArrayBuffer instance referenced by the array. + +#### Inherited from + +Uint8Array.buffer + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2156 + +___ + +### byteLength + +• `Readonly` **byteLength**: `number` + +The length in bytes of the array. + +#### Inherited from + +Uint8Array.byteLength + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2161 + +___ + +### byteOffset + +• `Readonly` **byteOffset**: `number` + +The offset in bytes of the array. + +#### Inherited from + +Uint8Array.byteOffset + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2166 + +___ + +### length + +• `Readonly` **length**: `number` + +The length of the array. + +#### Inherited from + +Uint8Array.length + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2265 + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +#### Returns + +[`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +#### Inherited from + +Uint8Array.[iterator] + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:270 + +___ + +### at + +▸ **at**(`index`): `undefined` \| `number` + +Takes an integer value and returns the item at that index, +allowing for positive and negative integers. +Negative integers count back from the last item in the array. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `index` | `number` | + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Uint8Array.at + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:94 + +___ + +### compare + +▸ **compare**(`target`, `targetStart?`, `targetEnd?`, `sourceStart?`, `sourceEnd?`): ``0`` \| ``1`` \| ``-1`` + +Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order. +Comparison is based on the actual sequence of bytes in each `Buffer`. + +* `0` is returned if `target` is the same as `buf` +* `1` is returned if `target` should come _before_`buf` when sorted. +* `-1` is returned if `target` should come _after_`buf` when sorted. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from('ABC'); +const buf2 = Buffer.from('BCD'); +const buf3 = Buffer.from('ABCD'); + +console.log(buf1.compare(buf1)); +// Prints: 0 +console.log(buf1.compare(buf2)); +// Prints: -1 +console.log(buf1.compare(buf3)); +// Prints: -1 +console.log(buf2.compare(buf1)); +// Prints: 1 +console.log(buf2.compare(buf3)); +// Prints: 1 +console.log([buf1, buf2, buf3].sort(Buffer.compare)); +// Prints: [ , , ] +// (This result is equal to: [buf1, buf3, buf2].) +``` + +The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`arguments can be used to limit the comparison to specific ranges within `target`and `buf` respectively. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]); +const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]); + +console.log(buf1.compare(buf2, 5, 9, 0, 4)); +// Prints: 0 +console.log(buf1.compare(buf2, 0, 6, 4)); +// Prints: -1 +console.log(buf1.compare(buf2, 5, 6, 5)); +// Prints: 1 +``` + +`ERR_OUT_OF_RANGE` is thrown if `targetStart < 0`, `sourceStart < 0`,`targetEnd > target.byteLength`, or `sourceEnd > source.byteLength`. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `target` | `Uint8Array` | A `Buffer` or Uint8Array with which to compare `buf`. | +| `targetStart?` | `number` | The offset within `target` at which to begin comparison. | +| `targetEnd?` | `number` | The offset within `target` at which to end comparison (not inclusive). | +| `sourceStart?` | `number` | The offset within `buf` at which to begin comparison. | +| `sourceEnd?` | `number` | The offset within `buf` at which to end comparison (not inclusive). | + +#### Returns + +``0`` \| ``1`` \| ``-1`` + +**`Since`** + +v0.11.13 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:798 + +___ + +### copy + +▸ **copy**(`target`, `targetStart?`, `sourceStart?`, `sourceEnd?`): `number` + +Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`. + +[`TypedArray.prototype.set()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set) performs the same operation, and is available +for all TypedArrays, including Node.js `Buffer`s, although it takes +different function arguments. + +```js +import { Buffer } from 'node:buffer'; + +// Create two `Buffer` instances. +const buf1 = Buffer.allocUnsafe(26); +const buf2 = Buffer.allocUnsafe(26).fill('!'); + +for (let i = 0; i < 26; i++) { + // 97 is the decimal ASCII value for 'a'. + buf1[i] = i + 97; +} + +// Copy `buf1` bytes 16 through 19 into `buf2` starting at byte 8 of `buf2`. +buf1.copy(buf2, 8, 16, 20); +// This is equivalent to: +// buf2.set(buf1.subarray(16, 20), 8); + +console.log(buf2.toString('ascii', 0, 25)); +// Prints: !!!!!!!!qrst!!!!!!!!!!!!! +``` + +```js +import { Buffer } from 'node:buffer'; + +// Create a `Buffer` and copy data from one region to an overlapping region +// within the same `Buffer`. + +const buf = Buffer.allocUnsafe(26); + +for (let i = 0; i < 26; i++) { + // 97 is the decimal ASCII value for 'a'. + buf[i] = i + 97; +} + +buf.copy(buf, 0, 4, 10); + +console.log(buf.toString()); +// Prints: efghijghijklmnopqrstuvwxyz +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `target` | `Uint8Array` | A `Buffer` or Uint8Array to copy into. | +| `targetStart?` | `number` | The offset within `target` at which to begin writing. | +| `sourceStart?` | `number` | The offset within `buf` from which to begin copying. | +| `sourceEnd?` | `number` | The offset within `buf` at which to stop copying (not inclusive). | + +#### Returns + +`number` + +The number of bytes copied. + +**`Since`** + +v0.1.90 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:858 + +___ + +### copyWithin + +▸ **copyWithin**(`target`, `start`, `end?`): [`Buffer`](../modules/internal-8.md#buffer) + +Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `target` | `number` | If target is negative, it is treated as length+target where length is the length of the array. | +| `start` | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. | +| `end?` | `number` | If not specified, length of the this object is used as its default value. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Inherited from + +Uint8Array.copyWithin + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2177 + +___ + +### entries + +▸ **entries**(): [`IterableIterator`](internal-8.IterableIterator.md)<[`number`, `number`]\> + +Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents +of `buf`. + +```js +import { Buffer } from 'node:buffer'; + +// Log the entire contents of a `Buffer`. + +const buf = Buffer.from('buffer'); + +for (const pair of buf.entries()) { + console.log(pair); +} +// Prints: +// [0, 98] +// [1, 117] +// [2, 102] +// [3, 102] +// [4, 101] +// [5, 114] +``` + +#### Returns + +[`IterableIterator`](internal-8.IterableIterator.md)<[`number`, `number`]\> + +**`Since`** + +v1.1.0 + +#### Overrides + +Uint8Array.entries + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2217 + +___ + +### equals + +▸ **equals**(`otherBuffer`): `boolean` + +Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from('ABC'); +const buf2 = Buffer.from('414243', 'hex'); +const buf3 = Buffer.from('ABCD'); + +console.log(buf1.equals(buf2)); +// Prints: true +console.log(buf1.equals(buf3)); +// Prints: false +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `otherBuffer` | `Uint8Array` | A `Buffer` or Uint8Array with which to compare `buf`. | + +#### Returns + +`boolean` + +**`Since`** + +v0.11.13 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:743 + +___ + +### every + +▸ **every**(`predicate`, `thisArg?`): `boolean` + +Determines whether all the members of an array satisfy the specified test. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `predicate` | (`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. | +| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | + +#### Returns + +`boolean` + +#### Inherited from + +Uint8Array.every + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2187 + +___ + +### fill + +▸ **fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../modules/internal-8.md#buffer) + +Fills `buf` with the specified `value`. If the `offset` and `end` are not given, +the entire `buf` will be filled: + +```js +import { Buffer } from 'node:buffer'; + +// Fill a `Buffer` with the ASCII character 'h'. + +const b = Buffer.allocUnsafe(50).fill('h'); + +console.log(b.toString()); +// Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh + +// Fill a buffer with empty string +const c = Buffer.allocUnsafe(5).fill(''); + +console.log(c.fill('')); +// Prints: +``` + +`value` is coerced to a `uint32` value if it is not a string, `Buffer`, or +integer. If the resulting integer is greater than `255` (decimal), `buf` will be +filled with `value & 255`. + +If the final write of a `fill()` operation falls on a multi-byte character, +then only the bytes of that character that fit into `buf` are written: + +```js +import { Buffer } from 'node:buffer'; + +// Fill a `Buffer` with character that takes up two bytes in UTF-8. + +console.log(Buffer.allocUnsafe(5).fill('\u0222')); +// Prints: +``` + +If `value` contains invalid characters, it is truncated; if no valid +fill data remains, an exception is thrown: + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(5); + +console.log(buf.fill('a')); +// Prints: +console.log(buf.fill('aazz', 'hex')); +// Prints: +console.log(buf.fill('zz', 'hex')); +// Throws an exception. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` \| `number` \| `Uint8Array` | The value with which to fill `buf`. Empty value (string, Uint8Array, Buffer) is coerced to `0`. | +| `offset?` | `number` | Number of bytes to skip before starting to fill `buf`. | +| `end?` | `number` | Where to stop filling `buf` (not inclusive). | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The encoding for `value` if `value` is a string. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +A reference to `buf`. + +**`Since`** + +v0.5.0 + +#### Overrides + +Uint8Array.fill + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2055 + +___ + +### filter + +▸ **filter**(`predicate`, `thisArg?`): `Uint8Array` + +Returns the elements of an array that meet the condition specified in a callback function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `predicate` | (`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `any` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. | +| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | + +#### Returns + +`Uint8Array` + +#### Inherited from + +Uint8Array.filter + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2206 + +___ + +### find + +▸ **find**(`predicate`, `thisArg?`): `undefined` \| `number` + +Returns the value of the first element in the array where predicate is true, and undefined +otherwise. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `predicate` | (`value`: `number`, `index`: `number`, `obj`: `Uint8Array`) => `boolean` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. | +| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +#### Returns + +`undefined` \| `number` + +#### Inherited from + +Uint8Array.find + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2217 + +___ + +### findIndex + +▸ **findIndex**(`predicate`, `thisArg?`): `number` + +Returns the index of the first element in the array where predicate is true, and -1 +otherwise. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `predicate` | (`value`: `number`, `index`: `number`, `obj`: `Uint8Array`) => `boolean` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. | +| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. | + +#### Returns + +`number` + +#### Inherited from + +Uint8Array.findIndex + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2228 + +___ + +### forEach + +▸ **forEach**(`callbackfn`, `thisArg?`): `void` + +Performs the specified action for each element in an array. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. | +| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +#### Returns + +`void` + +#### Inherited from + +Uint8Array.forEach + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2237 + +___ + +### includes + +▸ **includes**(`value`, `byteOffset?`, `encoding?`): `boolean` + +Equivalent to `buf.indexOf() !== -1`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('this is a buffer'); + +console.log(buf.includes('this')); +// Prints: true +console.log(buf.includes('is')); +// Prints: true +console.log(buf.includes(Buffer.from('a buffer'))); +// Prints: true +console.log(buf.includes(97)); +// Prints: true (97 is the decimal ASCII value for 'a') +console.log(buf.includes(Buffer.from('a buffer example'))); +// Prints: false +console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8))); +// Prints: true +console.log(buf.includes('this', 4)); +// Prints: false +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` \| `number` \| [`Buffer`](../modules/internal-8.md#buffer) | What to search for. | +| `byteOffset?` | `number` | Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | If `value` is a string, this is its encoding. | + +#### Returns + +`boolean` + +`true` if `value` was found in `buf`, `false` otherwise. + +**`Since`** + +v5.3.0 + +#### Overrides + +Uint8Array.includes + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2247 + +___ + +### indexOf + +▸ **indexOf**(`value`, `byteOffset?`, `encoding?`): `number` + +If `value` is: + +* a string, `value` is interpreted according to the character encoding in`encoding`. +* a `Buffer` or [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), `value` will be used in its entirety. +To compare a partial `Buffer`, use `buf.subarray`. +* a number, `value` will be interpreted as an unsigned 8-bit integer +value between `0` and `255`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('this is a buffer'); + +console.log(buf.indexOf('this')); +// Prints: 0 +console.log(buf.indexOf('is')); +// Prints: 2 +console.log(buf.indexOf(Buffer.from('a buffer'))); +// Prints: 8 +console.log(buf.indexOf(97)); +// Prints: 8 (97 is the decimal ASCII value for 'a') +console.log(buf.indexOf(Buffer.from('a buffer example'))); +// Prints: -1 +console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8))); +// Prints: 8 + +const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le'); + +console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le')); +// Prints: 4 +console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le')); +// Prints: 6 +``` + +If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value, +an integer between 0 and 255. + +If `byteOffset` is not a number, it will be coerced to a number. If the result +of coercion is `NaN` or `0`, then the entire buffer will be searched. This +behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf). + +```js +import { Buffer } from 'node:buffer'; + +const b = Buffer.from('abcdef'); + +// Passing a value that's a number, but not a valid byte. +// Prints: 2, equivalent to searching for 99 or 'c'. +console.log(b.indexOf(99.9)); +console.log(b.indexOf(256 + 99)); + +// Passing a byteOffset that coerces to NaN or 0. +// Prints: 1, searching the whole buffer. +console.log(b.indexOf('b', undefined)); +console.log(b.indexOf('b', {})); +console.log(b.indexOf('b', null)); +console.log(b.indexOf('b', [])); +``` + +If `value` is an empty string or empty `Buffer` and `byteOffset` is less +than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOffset` is at least `buf.length`, `buf.length` will be returned. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` \| `number` \| `Uint8Array` | What to search for. | +| `byteOffset?` | `number` | Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`. | + +#### Returns + +`number` + +The index of the first occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`. + +**`Since`** + +v1.5.0 + +#### Overrides + +Uint8Array.indexOf + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2124 + +___ + +### join + +▸ **join**(`separator?`): `string` + +Adds all the elements of an array separated by the specified separator string. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `separator?` | `string` | A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. | + +#### Returns + +`string` + +#### Inherited from + +Uint8Array.join + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2252 + +___ + +### keys + +▸ **keys**(): [`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices). + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('buffer'); + +for (const key of buf.keys()) { + console.log(key); +} +// Prints: +// 0 +// 1 +// 2 +// 3 +// 4 +// 5 +``` + +#### Returns + +[`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +**`Since`** + +v1.1.0 + +#### Overrides + +Uint8Array.keys + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2269 + +___ + +### lastIndexOf + +▸ **lastIndexOf**(`value`, `byteOffset?`, `encoding?`): `number` + +Identical to `buf.indexOf()`, except the last occurrence of `value` is found +rather than the first occurrence. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('this buffer is a buffer'); + +console.log(buf.lastIndexOf('this')); +// Prints: 0 +console.log(buf.lastIndexOf('buffer')); +// Prints: 17 +console.log(buf.lastIndexOf(Buffer.from('buffer'))); +// Prints: 17 +console.log(buf.lastIndexOf(97)); +// Prints: 15 (97 is the decimal ASCII value for 'a') +console.log(buf.lastIndexOf(Buffer.from('yolo'))); +// Prints: -1 +console.log(buf.lastIndexOf('buffer', 5)); +// Prints: 5 +console.log(buf.lastIndexOf('buffer', 4)); +// Prints: -1 + +const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le'); + +console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le')); +// Prints: 6 +console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le')); +// Prints: 4 +``` + +If `value` is not a string, number, or `Buffer`, this method will throw a`TypeError`. If `value` is a number, it will be coerced to a valid byte value, +an integer between 0 and 255. + +If `byteOffset` is not a number, it will be coerced to a number. Any arguments +that coerce to `NaN`, like `{}` or `undefined`, will search the whole buffer. +This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf). + +```js +import { Buffer } from 'node:buffer'; + +const b = Buffer.from('abcdef'); + +// Passing a value that's a number, but not a valid byte. +// Prints: 2, equivalent to searching for 99 or 'c'. +console.log(b.lastIndexOf(99.9)); +console.log(b.lastIndexOf(256 + 99)); + +// Passing a byteOffset that coerces to NaN. +// Prints: 1, searching the whole buffer. +console.log(b.lastIndexOf('b', undefined)); +console.log(b.lastIndexOf('b', {})); + +// Passing a byteOffset that coerces to 0. +// Prints: -1, equivalent to passing 0. +console.log(b.lastIndexOf('b', null)); +console.log(b.lastIndexOf('b', [])); +``` + +If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` \| `number` \| `Uint8Array` | What to search for. | +| `byteOffset?` | `number` | Where to begin searching in `buf`. If negative, then offset is calculated from the end of `buf`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | If `value` is a string, this is the encoding used to determine the binary representation of the string that will be searched for in `buf`. | + +#### Returns + +`number` + +The index of the last occurrence of `value` in `buf`, or `-1` if `buf` does not contain `value`. + +**`Since`** + +v6.0.0 + +#### Overrides + +Uint8Array.lastIndexOf + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2192 + +___ + +### map + +▸ **map**(`callbackfn`, `thisArg?`): `Uint8Array` + +Calls a defined callback function on each element of an array, and returns an array that +contains the results. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `number` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. | +| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. | + +#### Returns + +`Uint8Array` + +#### Inherited from + +Uint8Array.map + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2275 + +___ + +### readBigInt64BE + +▸ **readBigInt64BE**(`offset?`): `bigint` + +Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed +values. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`bigint` + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1197 + +___ + +### readBigInt64LE + +▸ **readBigInt64LE**(`offset?`): `bigint` + +Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed +values. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`bigint` + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1206 + +___ + +### readBigUInt64BE + +▸ **readBigUInt64BE**(`offset?`): `bigint` + +Reads an unsigned, big-endian 64-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readBigUint64BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]); + +console.log(buf.readBigUInt64BE(0)); +// Prints: 4294967295n +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`bigint` + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1161 + +___ + +### readBigUInt64LE + +▸ **readBigUInt64LE**(`offset?`): `bigint` + +Reads an unsigned, little-endian 64-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readBigUint64LE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]); + +console.log(buf.readBigUInt64LE(0)); +// Prints: 18446744069414584320n +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`bigint` + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1183 + +___ + +### readBigUint64BE + +▸ **readBigUint64BE**(`offset?`): `bigint` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`bigint` + +**`Alias`** + +Buffer.readBigUInt64BE + +**`Since`** + +v14.10.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1166 + +___ + +### readBigUint64LE + +▸ **readBigUint64LE**(`offset?`): `bigint` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`bigint` + +**`Alias`** + +Buffer.readBigUInt64LE + +**`Since`** + +v14.10.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1188 + +___ + +### readDoubleBE + +▸ **readDoubleBE**(`offset?`): `number` + +Reads a 64-bit, big-endian double from `buf` at the specified `offset`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); + +console.log(buf.readDoubleBE(0)); +// Prints: 8.20788039913184e-304 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1573 + +___ + +### readDoubleLE + +▸ **readDoubleLE**(`offset?`): `number` + +Reads a 64-bit, little-endian double from `buf` at the specified `offset`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); + +console.log(buf.readDoubleLE(0)); +// Prints: 5.447603722011605e-270 +console.log(buf.readDoubleLE(1)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1558 + +___ + +### readFloatBE + +▸ **readFloatBE**(`offset?`): `number` + +Reads a 32-bit, big-endian float from `buf` at the specified `offset`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([1, 2, 3, 4]); + +console.log(buf.readFloatBE(0)); +// Prints: 2.387939260590663e-38 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1541 + +___ + +### readFloatLE + +▸ **readFloatLE**(`offset?`): `number` + +Reads a 32-bit, little-endian float from `buf` at the specified `offset`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([1, 2, 3, 4]); + +console.log(buf.readFloatLE(0)); +// Prints: 1.539989614439558e-36 +console.log(buf.readFloatLE(1)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1526 + +___ + +### readInt16BE + +▸ **readInt16BE**(`offset?`): `number` + +Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed values. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0, 5]); + +console.log(buf.readInt16BE(0)); +// Prints: 5 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1473 + +___ + +### readInt16LE + +▸ **readInt16LE**(`offset?`): `number` + +Reads a signed, little-endian 16-bit integer from `buf` at the specified`offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed values. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0, 5]); + +console.log(buf.readInt16LE(0)); +// Prints: 1280 +console.log(buf.readInt16LE(1)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1456 + +___ + +### readInt32BE + +▸ **readInt32BE**(`offset?`): `number` + +Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed values. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0, 0, 0, 5]); + +console.log(buf.readInt32BE(0)); +// Prints: 5 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1509 + +___ + +### readInt32LE + +▸ **readInt32LE**(`offset?`): `number` + +Reads a signed, little-endian 32-bit integer from `buf` at the specified`offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed values. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0, 0, 0, 5]); + +console.log(buf.readInt32LE(0)); +// Prints: 83886080 +console.log(buf.readInt32LE(1)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1492 + +___ + +### readInt8 + +▸ **readInt8**(`offset?`): `number` + +Reads a signed 8-bit integer from `buf` at the specified `offset`. + +Integers read from a `Buffer` are interpreted as two's complement signed values. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([-1, 5]); + +console.log(buf.readInt8(0)); +// Prints: -1 +console.log(buf.readInt8(1)); +// Prints: 5 +console.log(buf.readInt8(2)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1437 + +___ + +### readIntBE + +▸ **readIntBE**(`offset`, `byteLength`): `number` + +Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a big-endian, two's complement signed value +supporting up to 48 bits of accuracy. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + +console.log(buf.readIntBE(0, 6).toString(16)); +// Prints: 1234567890ab +console.log(buf.readIntBE(1, 6).toString(16)); +// Throws ERR_OUT_OF_RANGE. +console.log(buf.readIntBE(1, 0).toString(16)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to read. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1294 + +___ + +### readIntLE + +▸ **readIntLE**(`offset`, `byteLength`): `number` + +Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a little-endian, two's complement signed value +supporting up to 48 bits of accuracy. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + +console.log(buf.readIntLE(0, 6).toString(16)); +// Prints: -546f87a9cbee +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to read. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1273 + +___ + +### readUInt16BE + +▸ **readUInt16BE**(`offset?`): `number` + +Reads an unsigned, big-endian 16-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readUint16BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56]); + +console.log(buf.readUInt16BE(0).toString(16)); +// Prints: 1234 +console.log(buf.readUInt16BE(1).toString(16)); +// Prints: 3456 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1365 + +___ + +### readUInt16LE + +▸ **readUInt16LE**(`offset?`): `number` + +Reads an unsigned, little-endian 16-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readUint16LE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56]); + +console.log(buf.readUInt16LE(0).toString(16)); +// Prints: 3412 +console.log(buf.readUInt16LE(1).toString(16)); +// Prints: 5634 +console.log(buf.readUInt16LE(2).toString(16)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1341 + +___ + +### readUInt32BE + +▸ **readUInt32BE**(`offset?`): `number` + +Reads an unsigned, big-endian 32-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readUint32BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]); + +console.log(buf.readUInt32BE(0).toString(16)); +// Prints: 12345678 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1411 + +___ + +### readUInt32LE + +▸ **readUInt32LE**(`offset?`): `number` + +Reads an unsigned, little-endian 32-bit integer from `buf` at the specified`offset`. + +This function is also available under the `readUint32LE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]); + +console.log(buf.readUInt32LE(0).toString(16)); +// Prints: 78563412 +console.log(buf.readUInt32LE(1).toString(16)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1389 + +___ + +### readUInt8 + +▸ **readUInt8**(`offset?`): `number` + +Reads an unsigned 8-bit integer from `buf` at the specified `offset`. + +This function is also available under the `readUint8` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([1, -2]); + +console.log(buf.readUInt8(0)); +// Prints: 1 +console.log(buf.readUInt8(1)); +// Prints: 254 +console.log(buf.readUInt8(2)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset?` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - 1`. | + +#### Returns + +`number` + +**`Since`** + +v0.5.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1315 + +___ + +### readUIntBE + +▸ **readUIntBE**(`offset`, `byteLength`): `number` + +Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned big-endian integer supporting +up to 48 bits of accuracy. + +This function is also available under the `readUintBE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + +console.log(buf.readUIntBE(0, 6).toString(16)); +// Prints: 1234567890ab +console.log(buf.readUIntBE(1, 6).toString(16)); +// Throws ERR_OUT_OF_RANGE. +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to read. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1251 + +___ + +### readUIntLE + +▸ **readUIntLE**(`offset`, `byteLength`): `number` + +Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned, little-endian integer supporting +up to 48 bits of accuracy. + +This function is also available under the `readUintLE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); + +console.log(buf.readUIntLE(0, 6).toString(16)); +// Prints: ab9078563412 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `offset` | `number` | Number of bytes to skip before starting to read. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to read. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1225 + +___ + +### readUint16BE + +▸ **readUint16BE**(`offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUInt16BE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1370 + +___ + +### readUint16LE + +▸ **readUint16LE**(`offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUInt16LE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1346 + +___ + +### readUint32BE + +▸ **readUint32BE**(`offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUInt32BE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1416 + +___ + +### readUint32LE + +▸ **readUint32LE**(`offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUInt32LE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1394 + +___ + +### readUint8 + +▸ **readUint8**(`offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUInt8 + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1320 + +___ + +### readUintBE + +▸ **readUintBE**(`offset`, `byteLength`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset` | `number` | +| `byteLength` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUIntBE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1256 + +___ + +### readUintLE + +▸ **readUintLE**(`offset`, `byteLength`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `offset` | `number` | +| `byteLength` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.readUIntLE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1230 + +___ + +### reduce + +▸ **reduce**(`callbackfn`): `number` + +Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | + +#### Returns + +`number` + +#### Inherited from + +Uint8Array.reduce + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2287 + +▸ **reduce**(`callbackfn`, `initialValue`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callbackfn` | (`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number` | +| `initialValue` | `number` | + +#### Returns + +`number` + +#### Inherited from + +Uint8Array.reduce + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2288 + +▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` + +Calls the specified callback function for all the elements in an array. The return value of +the callback function is the accumulated result, and is provided as an argument in the next +call to the callback function. + +#### Type parameters + +| Name | +| :------ | +| `U` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. | +| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +#### Returns + +`U` + +#### Inherited from + +Uint8Array.reduce + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2300 + +___ + +### reduceRight + +▸ **reduceRight**(`callbackfn`): `number` + +Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | + +#### Returns + +`number` + +#### Inherited from + +Uint8Array.reduceRight + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2312 + +▸ **reduceRight**(`callbackfn`, `initialValue`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callbackfn` | (`previousValue`: `number`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `number` | +| `initialValue` | `number` | + +#### Returns + +`number` + +#### Inherited from + +Uint8Array.reduceRight + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2313 + +▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` + +Calls the specified callback function for all the elements in an array, in descending order. +The return value of the callback function is the accumulated result, and is provided as an +argument in the next call to the callback function. + +#### Type parameters + +| Name | +| :------ | +| `U` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `callbackfn` | (`previousValue`: `U`, `currentValue`: `number`, `currentIndex`: `number`, `array`: `Uint8Array`) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. | +| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. | + +#### Returns + +`U` + +#### Inherited from + +Uint8Array.reduceRight + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2325 + +___ + +### reverse + +▸ **reverse**(): [`Buffer`](../modules/internal-8.md#buffer) + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Overrides + +Uint8Array.reverse + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1574 + +___ + +### set + +▸ **set**(`array`, `offset?`): `void` + +Sets a value or an array of values. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `array` | [`ArrayLike`](internal-8.ArrayLike.md)<`number`\> | A typed or untyped array of values to set. | +| `offset?` | `number` | The index in the current array at which the values are to be written. | + +#### Returns + +`void` + +#### Inherited from + +Uint8Array.set + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2337 + +___ + +### slice + +▸ **slice**(`start?`, `end?`): [`Buffer`](../modules/internal-8.md#buffer) + +Returns a new `Buffer` that references the same memory as the original, but +offset and cropped by the `start` and `end` indices. + +This method is not compatible with the `Uint8Array.prototype.slice()`, +which is a superclass of `Buffer`. To copy the slice, use`Uint8Array.prototype.slice()`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('buffer'); + +const copiedBuf = Uint8Array.prototype.slice.call(buf); +copiedBuf[0]++; +console.log(copiedBuf.toString()); +// Prints: cuffer + +console.log(buf.toString()); +// Prints: buffer + +// With buf.slice(), the original buffer is modified. +const notReallyCopiedBuf = buf.slice(); +notReallyCopiedBuf[0]++; +console.log(notReallyCopiedBuf.toString()); +// Prints: cuffer +console.log(buf.toString()); +// Also prints: cuffer (!) +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `start?` | `number` | Where the new `Buffer` will start. | +| `end?` | `number` | Where the new `Buffer` will end (not inclusive). | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v0.3.0 + +**`Deprecated`** + +Use `subarray` instead. + +#### Overrides + +Uint8Array.slice + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:892 + +___ + +### some + +▸ **some**(`predicate`, `thisArg?`): `boolean` + +Determines whether the specified callback function returns true for any element of an array. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `predicate` | (`value`: `number`, `index`: `number`, `array`: `Uint8Array`) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. | +| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. | + +#### Returns + +`boolean` + +#### Inherited from + +Uint8Array.some + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2354 + +___ + +### sort + +▸ **sort**(`compareFn?`): [`Buffer`](../modules/internal-8.md#buffer) + +Sorts an array. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `compareFn?` | (`a`: `number`, `b`: `number`) => `number` | Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order. ```ts [11,2,22,1].sort((a, b) => a - b) ``` | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Inherited from + +Uint8Array.sort + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2365 + +___ + +### subarray + +▸ **subarray**(`start?`, `end?`): [`Buffer`](../modules/internal-8.md#buffer) + +Returns a new `Buffer` that references the same memory as the original, but +offset and cropped by the `start` and `end` indices. + +Specifying `end` greater than `buf.length` will return the same result as +that of `end` equal to `buf.length`. + +This method is inherited from [`TypedArray.prototype.subarray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray). + +Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap. + +```js +import { Buffer } from 'node:buffer'; + +// Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte +// from the original `Buffer`. + +const buf1 = Buffer.allocUnsafe(26); + +for (let i = 0; i < 26; i++) { + // 97 is the decimal ASCII value for 'a'. + buf1[i] = i + 97; +} + +const buf2 = buf1.subarray(0, 3); + +console.log(buf2.toString('ascii', 0, buf2.length)); +// Prints: abc + +buf1[0] = 33; + +console.log(buf2.toString('ascii', 0, buf2.length)); +// Prints: !bc +``` + +Specifying negative indexes causes the slice to be generated relative to the +end of `buf` rather than the beginning. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('buffer'); + +console.log(buf.subarray(-6, -1).toString()); +// Prints: buffe +// (Equivalent to buf.subarray(0, 5).) + +console.log(buf.subarray(-6, -2).toString()); +// Prints: buff +// (Equivalent to buf.subarray(0, 4).) + +console.log(buf.subarray(-5, -2).toString()); +// Prints: uff +// (Equivalent to buf.subarray(1, 4).) +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `start?` | `number` | Where the new `Buffer` will start. | +| `end?` | `number` | Where the new `Buffer` will end (not inclusive). | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v3.0.0 + +#### Overrides + +Uint8Array.subarray + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:952 + +___ + +### swap16 + +▸ **swap16**(): [`Buffer`](../modules/internal-8.md#buffer) + +Interprets `buf` as an array of unsigned 16-bit integers and swaps the +byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + +console.log(buf1); +// Prints: + +buf1.swap16(); + +console.log(buf1); +// Prints: + +const buf2 = Buffer.from([0x1, 0x2, 0x3]); + +buf2.swap16(); +// Throws ERR_INVALID_BUFFER_SIZE. +``` + +One convenient use of `buf.swap16()` is to perform a fast in-place conversion +between UTF-16 little-endian and UTF-16 big-endian: + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('This is little-endian UTF-16', 'utf16le'); +buf.swap16(); // Convert to big-endian UTF-16 text. +``` + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +A reference to `buf`. + +**`Since`** + +v5.10.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1610 + +___ + +### swap32 + +▸ **swap32**(): [`Buffer`](../modules/internal-8.md#buffer) + +Interprets `buf` as an array of unsigned 32-bit integers and swaps the +byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + +console.log(buf1); +// Prints: + +buf1.swap32(); + +console.log(buf1); +// Prints: + +const buf2 = Buffer.from([0x1, 0x2, 0x3]); + +buf2.swap32(); +// Throws ERR_INVALID_BUFFER_SIZE. +``` + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +A reference to `buf`. + +**`Since`** + +v5.10.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1636 + +___ + +### swap64 + +▸ **swap64**(): [`Buffer`](../modules/internal-8.md#buffer) + +Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_. +Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); + +console.log(buf1); +// Prints: + +buf1.swap64(); + +console.log(buf1); +// Prints: + +const buf2 = Buffer.from([0x1, 0x2, 0x3]); + +buf2.swap64(); +// Throws ERR_INVALID_BUFFER_SIZE. +``` + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +A reference to `buf`. + +**`Since`** + +v6.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1662 + +___ + +### toJSON + +▸ **toJSON**(): `Object` + +Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls +this function when stringifying a `Buffer` instance. + +`Buffer.from()` accepts objects in the format returned from this method. +In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]); +const json = JSON.stringify(buf); + +console.log(json); +// Prints: {"type":"Buffer","data":[1,2,3,4,5]} + +const copy = JSON.parse(json, (key, value) => { + return value && value.type === 'Buffer' ? + Buffer.from(value) : + value; +}); + +console.log(copy); +// Prints: +``` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `data` | `number`[] | +| `type` | ``"Buffer"`` | + +**`Since`** + +v0.9.2 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:721 + +___ + +### toLocaleString + +▸ **toLocaleString**(): `string` + +Converts a number to a string by using the current locale. + +#### Returns + +`string` + +#### Inherited from + +Uint8Array.toLocaleString + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2378 + +___ + +### toString + +▸ **toString**(`encoding?`, `start?`, `end?`): `string` + +Decodes `buf` to a string according to the specified character encoding in`encoding`. `start` and `end` may be passed to decode only a subset of `buf`. + +If `encoding` is `'utf8'` and a byte sequence in the input is not valid UTF-8, +then each invalid byte is replaced with the replacement character `U+FFFD`. + +The maximum length of a string instance (in UTF-16 code units) is available +as constants.MAX_STRING_LENGTH. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.allocUnsafe(26); + +for (let i = 0; i < 26; i++) { + // 97 is the decimal ASCII value for 'a'. + buf1[i] = i + 97; +} + +console.log(buf1.toString('utf8')); +// Prints: abcdefghijklmnopqrstuvwxyz +console.log(buf1.toString('utf8', 0, 5)); +// Prints: abcde + +const buf2 = Buffer.from('tést'); + +console.log(buf2.toString('hex')); +// Prints: 74c3a97374 +console.log(buf2.toString('utf8', 0, 3)); +// Prints: té +console.log(buf2.toString(undefined, 0, 3)); +// Prints: té +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The character encoding to use. | +| `start?` | `number` | The byte offset to start decoding at. | +| `end?` | `number` | The byte offset to stop decoding at (not inclusive). | + +#### Returns + +`string` + +**`Since`** + +v0.1.90 + +#### Overrides + +Uint8Array.toString + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:693 + +___ + +### valueOf + +▸ **valueOf**(): `Uint8Array` + +Returns the primitive value of the specified object. + +#### Returns + +`Uint8Array` + +#### Inherited from + +Uint8Array.valueOf + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:2386 + +___ + +### values + +▸ **values**(): [`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is +called automatically when a `Buffer` is used in a `for..of` statement. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.from('buffer'); + +for (const value of buf.values()) { + console.log(value); +} +// Prints: +// 98 +// 117 +// 102 +// 102 +// 101 +// 114 + +for (const value of buf) { + console.log(value); +} +// Prints: +// 98 +// 117 +// 102 +// 102 +// 101 +// 114 +``` + +#### Returns + +[`IterableIterator`](internal-8.IterableIterator.md)<`number`\> + +**`Since`** + +v1.1.0 + +#### Overrides + +Uint8Array.values + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2303 + +___ + +### write + +▸ **write**(`string`, `encoding?`): `number` + +Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did +not contain enough space to fit the entire string, only part of `string` will be +written. However, partially encoded characters will not be written. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.alloc(256); + +const len = buf.write('\u00bd + \u00bc = \u00be', 0); + +console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`); +// Prints: 12 bytes: ½ + ¼ = ¾ + +const buffer = Buffer.alloc(10); + +const length = buffer.write('abcd', 8); + +console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`); +// Prints: 2 bytes : ab +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `string` | `string` | String to write to `buf`. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | The character encoding of `string`. | + +#### Returns + +`number` + +Number of bytes written. + +**`Since`** + +v0.1.90 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:652 + +▸ **write**(`string`, `offset`, `encoding?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `string` | `string` | +| `offset` | `number` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:653 + +▸ **write**(`string`, `offset`, `length`, `encoding?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `string` | `string` | +| `offset` | `number` | +| `length` | `number` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:654 + +___ + +### writeBigInt64BE + +▸ **writeBigInt64BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. + +`value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeBigInt64BE(0x0102030405060708n, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `bigint` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:973 + +___ + +### writeBigInt64LE + +▸ **writeBigInt64LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. + +`value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeBigInt64LE(0x0102030405060708n, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `bigint` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:994 + +___ + +### writeBigUInt64BE + +▸ **writeBigUInt64BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. + +This function is also available under the `writeBigUint64BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeBigUInt64BE(0xdecafafecacefaden, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `bigint` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1015 + +___ + +### writeBigUInt64LE + +▸ **writeBigUInt64LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeBigUInt64LE(0xdecafafecacefaden, 0); + +console.log(buf); +// Prints: +``` + +This function is also available under the `writeBigUint64LE` alias. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `bigint` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v12.0.0, v10.20.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1041 + +___ + +### writeBigUint64BE + +▸ **writeBigUint64BE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `bigint` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeBigUInt64BE + +**`Since`** + +v14.10.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1020 + +___ + +### writeBigUint64LE + +▸ **writeBigUint64LE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `bigint` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeBigUInt64LE + +**`Since`** + +v14.10.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1046 + +___ + +### writeDoubleBE + +▸ **writeDoubleBE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything +other than a JavaScript number. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeDoubleBE(123.456, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1995 + +___ + +### writeDoubleLE + +▸ **writeDoubleLE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything +other than a JavaScript number. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(8); + +buf.writeDoubleLE(123.456, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 8`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1975 + +___ + +### writeFloatBE + +▸ **writeFloatBE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is +undefined when `value` is anything other than a JavaScript number. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeFloatBE(0xcafebabe, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1955 + +___ + +### writeFloatLE + +▸ **writeFloatLE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is +undefined when `value` is anything other than a JavaScript number. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeFloatLE(0xcafebabe, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1935 + +___ + +### writeInt16BE + +▸ **writeInt16BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is +anything other than a signed 16-bit integer. + +The `value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(2); + +buf.writeInt16BE(0x0102, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1871 + +___ + +### writeInt16LE + +▸ **writeInt16LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is +anything other than a signed 16-bit integer. + +The `value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(2); + +buf.writeInt16LE(0x0304, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1849 + +___ + +### writeInt32BE + +▸ **writeInt32BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is +anything other than a signed 32-bit integer. + +The `value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeInt32BE(0x01020304, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1915 + +___ + +### writeInt32LE + +▸ **writeInt32LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is +anything other than a signed 32-bit integer. + +The `value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeInt32LE(0x05060708, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1893 + +___ + +### writeInt8 + +▸ **writeInt8**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset`. `value` must be a valid +signed 8-bit integer. Behavior is undefined when `value` is anything other than +a signed 8-bit integer. + +`value` is interpreted and written as a two's complement signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(2); + +buf.writeInt8(2, 0); +buf.writeInt8(-2, 1); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1827 + +___ + +### writeIntBE + +▸ **writeIntBE**(`value`, `offset`, `byteLength`): `number` + +Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when`value` is anything other than a +signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(6); + +buf.writeIntBE(0x1234567890ab, 0, 6); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to write. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1144 + +___ + +### writeIntLE + +▸ **writeIntLE**(`value`, `offset`, `byteLength`): `number` + +Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +when `value` is anything other than a signed integer. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(6); + +buf.writeIntLE(0x1234567890ab, 0, 6); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to write. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.11.15 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1123 + +___ + +### writeUInt16BE + +▸ **writeUInt16BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value`is anything other than an +unsigned 16-bit integer. + +This function is also available under the `writeUint16BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeUInt16BE(0xdead, 0); +buf.writeUInt16BE(0xbeef, 2); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1744 + +___ + +### writeUInt16LE + +▸ **writeUInt16LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is +anything other than an unsigned 16-bit integer. + +This function is also available under the `writeUint16LE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeUInt16LE(0xdead, 0); +buf.writeUInt16LE(0xbeef, 2); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 2`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1716 + +___ + +### writeUInt32BE + +▸ **writeUInt32BE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value`is anything other than an +unsigned 32-bit integer. + +This function is also available under the `writeUint32BE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeUInt32BE(0xfeedface, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1798 + +___ + +### writeUInt32LE + +▸ **writeUInt32LE**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is +anything other than an unsigned 32-bit integer. + +This function is also available under the `writeUint32LE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeUInt32LE(0xfeedface, 0); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 4`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1771 + +___ + +### writeUInt8 + +▸ **writeUInt8**(`value`, `offset?`): `number` + +Writes `value` to `buf` at the specified `offset`. `value` must be a +valid unsigned 8-bit integer. Behavior is undefined when `value` is anything +other than an unsigned 8-bit integer. + +This function is also available under the `writeUint8` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(4); + +buf.writeUInt8(0x3, 0); +buf.writeUInt8(0x4, 1); +buf.writeUInt8(0x23, 2); +buf.writeUInt8(0x42, 3); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset?` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - 1`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1688 + +___ + +### writeUIntBE + +▸ **writeUIntBE**(`value`, `offset`, `byteLength`): `number` + +Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined +when `value` is anything other than an unsigned integer. + +This function is also available under the `writeUintBE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(6); + +buf.writeUIntBE(0x1234567890ab, 0, 6); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to write. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1097 + +___ + +### writeUIntLE + +▸ **writeUIntLE**(`value`, `offset`, `byteLength`): `number` + +Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +when `value` is anything other than an unsigned integer. + +This function is also available under the `writeUintLE` alias. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(6); + +buf.writeUIntLE(0x1234567890ab, 0, 6); + +console.log(buf); +// Prints: +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `value` | `number` | Number to be written to `buf`. | +| `offset` | `number` | Number of bytes to skip before starting to write. Must satisfy `0 <= offset <= buf.length - byteLength`. | +| `byteLength` | `number` | Number of bytes to write. Must satisfy `0 < byteLength <= 6`. | + +#### Returns + +`number` + +`offset` plus the number of bytes written. + +**`Since`** + +v0.5.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1069 + +___ + +### writeUint16BE + +▸ **writeUint16BE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUInt16BE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1749 + +___ + +### writeUint16LE + +▸ **writeUint16LE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUInt16LE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1721 + +___ + +### writeUint32BE + +▸ **writeUint32BE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUInt32BE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1803 + +___ + +### writeUint32LE + +▸ **writeUint32LE**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUInt32LE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1776 + +___ + +### writeUint8 + +▸ **writeUint8**(`value`, `offset?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset?` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUInt8 + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1693 + +___ + +### writeUintBE + +▸ **writeUintBE**(`value`, `offset`, `byteLength`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset` | `number` | +| `byteLength` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUIntBE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1102 + +___ + +### writeUintLE + +▸ **writeUintLE**(`value`, `offset`, `byteLength`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `number` | +| `offset` | `number` | +| `byteLength` | `number` | + +#### Returns + +`number` + +**`Alias`** + +Buffer.writeUIntLE + +**`Since`** + +v14.9.0, v12.19.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:1074 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md new file mode 100644 index 0000000000..a12f768b20 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.BufferConstructor.md @@ -0,0 +1,606 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: BufferConstructor + +[internal](../modules/internal-8.md).BufferConstructor + +Raw data is stored in instances of the Buffer class. +A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. +Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex' + +## Properties + +### poolSize + +• **poolSize**: `number` + +This is the size (in bytes) of pre-allocated internal `Buffer` instances used +for pooling. This value may be modified. + +**`Since`** + +v0.11.3 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:620 + +## Methods + +### alloc + +▸ **alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../modules/internal-8.md#buffer) + +Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.alloc(5); + +console.log(buf); +// Prints: +``` + +If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. + +If `fill` is specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill)`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.alloc(5, 'a'); + +console.log(buf); +// Prints: +``` + +If both `fill` and `encoding` are specified, the allocated `Buffer` will be +initialized by calling `buf.fill(fill, encoding)`. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64'); + +console.log(buf); +// Prints: +``` + +Calling `Buffer.alloc()` can be measurably slower than the alternative `Buffer.allocUnsafe()` but ensures that the newly created `Buffer` instance +contents will never contain sensitive data from previous allocations, including +data that might not have been allocated for `Buffer`s. + +A `TypeError` will be thrown if `size` is not a number. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size` | `number` | The desired length of the new `Buffer`. | +| `fill?` | `string` \| `number` \| `Uint8Array` | A value to pre-fill the new `Buffer` with. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | If `fill` is a string, this is its encoding. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v5.10.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:533 + +___ + +### allocUnsafe + +▸ **allocUnsafe**(`size`): [`Buffer`](../modules/internal-8.md#buffer) + +Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. + +The underlying memory for `Buffer` instances created in this way is _not_ +_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `Buffer.alloc()` instead to initialize`Buffer` instances with zeroes. + +```js +import { Buffer } from 'node:buffer'; + +const buf = Buffer.allocUnsafe(10); + +console.log(buf); +// Prints (contents may vary): + +buf.fill(0); + +console.log(buf); +// Prints: +``` + +A `TypeError` will be thrown if `size` is not a number. + +The `Buffer` module pre-allocates an internal `Buffer` instance of +size `Buffer.poolSize` that is used as a pool for the fast allocation of new`Buffer` instances created using `Buffer.allocUnsafe()`, `Buffer.from(array)`, +and `Buffer.concat()` only when `size` is less than or equal to`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). + +Use of this pre-allocated internal memory pool is a key difference between +calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`. +Specifically, `Buffer.alloc(size, fill)` will _never_ use the internal `Buffer`pool, while `Buffer.allocUnsafe(size).fill(fill)`_will_ use the internal`Buffer` pool if `size` is less +than or equal to half `Buffer.poolSize`. The +difference is subtle but can be important when an application requires the +additional performance that `Buffer.allocUnsafe()` provides. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size` | `number` | The desired length of the new `Buffer`. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v5.10.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:569 + +___ + +### allocUnsafeSlow + +▸ **allocUnsafeSlow**(`size`): [`Buffer`](../modules/internal-8.md#buffer) + +Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. A zero-length `Buffer` is created if +`size` is 0. + +The underlying memory for `Buffer` instances created in this way is _not_ +_initialized_. The contents of the newly created `Buffer` are unknown and _may contain sensitive data_. Use `buf.fill(0)` to initialize +such `Buffer` instances with zeroes. + +When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances, +allocations under 4 KiB are sliced from a single pre-allocated `Buffer`. This +allows applications to avoid the garbage collection overhead of creating many +individually allocated `Buffer` instances. This approach improves both +performance and memory usage by eliminating the need to track and clean up as +many individual `ArrayBuffer` objects. + +However, in the case where a developer may need to retain a small chunk of +memory from a pool for an indeterminate amount of time, it may be appropriate +to create an un-pooled `Buffer` instance using `Buffer.allocUnsafeSlow()` and +then copying out the relevant bits. + +```js +import { Buffer } from 'node:buffer'; + +// Need to keep around a few small chunks of memory. +const store = []; + +socket.on('readable', () => { + let data; + while (null !== (data = readable.read())) { + // Allocate for retained data. + const sb = Buffer.allocUnsafeSlow(10); + + // Copy the data into the new allocation. + data.copy(sb, 0, 0, 10); + + store.push(sb); + } +}); +``` + +A `TypeError` will be thrown if `size` is not a number. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `size` | `number` | The desired length of the new `Buffer`. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v5.12.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:614 + +___ + +### byteLength + +▸ **byteLength**(`string`, `encoding?`): `number` + +Returns the byte length of a string when encoded using `encoding`. +This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account +for the encoding that is used to convert the string into bytes. + +For `'base64'`, `'base64url'`, and `'hex'`, this function assumes valid input. +For strings that contain non-base64/hex-encoded data (e.g. whitespace), the +return value might be greater than the length of a `Buffer` created from the +string. + +```js +import { Buffer } from 'node:buffer'; + +const str = '\u00bd + \u00bc = \u00be'; + +console.log(`${str}: ${str.length} characters, ` + + `${Buffer.byteLength(str, 'utf8')} bytes`); +// Prints: ½ + ¼ = ¾: 9 characters, 12 bytes +``` + +When `string` is a +`Buffer`/[`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView)/[`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/- +Reference/Global_Objects/TypedArray)/[`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)/[`SharedArrayBuffer`](https://develop- +er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), the byte length as reported by `.byteLength`is returned. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `string` | `string` \| `ArrayBuffer` \| [`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer) \| [`ArrayBufferView`](../modules/internal-8.md#arraybufferview) | A value to calculate the length of. | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | If `string` is a string, this is its encoding. | + +#### Returns + +`number` + +The number of bytes contained within `string`. + +**`Since`** + +v0.1.90 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:408 + +___ + +### compare + +▸ **compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1`` + +Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`. + +```js +import { Buffer } from 'node:buffer'; + +const buf1 = Buffer.from('1234'); +const buf2 = Buffer.from('0123'); +const arr = [buf1, buf2]; + +console.log(arr.sort(Buffer.compare)); +// Prints: [ , ] +// (This result is equal to: [buf2, buf1].) +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buf1` | `Uint8Array` | +| `buf2` | `Uint8Array` | + +#### Returns + +``0`` \| ``1`` \| ``-1`` + +Either `-1`, `0`, or `1`, depending on the result of the comparison. See `compare` for details. + +**`Since`** + +v0.11.13 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:485 + +___ + +### concat + +▸ **concat**(`list`, `totalLength?`): [`Buffer`](../modules/internal-8.md#buffer) + +Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together. + +If the list has no items, or if the `totalLength` is 0, then a new zero-length`Buffer` is returned. + +If `totalLength` is not provided, it is calculated from the `Buffer` instances +in `list` by adding their lengths. + +If `totalLength` is provided, it is coerced to an unsigned integer. If the +combined length of the `Buffer`s in `list` exceeds `totalLength`, the result is +truncated to `totalLength`. + +```js +import { Buffer } from 'node:buffer'; + +// Create a single `Buffer` from a list of three `Buffer` instances. + +const buf1 = Buffer.alloc(10); +const buf2 = Buffer.alloc(14); +const buf3 = Buffer.alloc(18); +const totalLength = buf1.length + buf2.length + buf3.length; + +console.log(totalLength); +// Prints: 42 + +const bufA = Buffer.concat([buf1, buf2, buf3], totalLength); + +console.log(bufA); +// Prints: +console.log(bufA.length); +// Prints: 42 +``` + +`Buffer.concat()` may also use the internal `Buffer` pool like `Buffer.allocUnsafe()` does. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `list` | readonly `Uint8Array`[] | List of `Buffer` or Uint8Array instances to concatenate. | +| `totalLength?` | `number` | Total length of the `Buffer` instances in `list` when concatenated. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v0.7.11 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:450 + +___ + +### copyBytesFrom + +▸ **copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../modules/internal-8.md#buffer) + +Copies the underlying memory of `view` into a new `Buffer`. + +```js +const u16 = new Uint16Array([0, 0xffff]); +const buf = Buffer.copyBytesFrom(u16, 1, 1); +u16[1] = 0; +console.log(buf.length); // 2 +console.log(buf[0]); // 255 +console.log(buf[1]); // 255 +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `view` | [`TypedArray`](../modules/internal-8.md#typedarray) | The {TypedArray} to copy. | +| `offset?` | `number` | The starting offset within `view`. | +| `length?` | `number` | The number of elements from `view` to copy. | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v19.8.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:467 + +___ + +### from + +▸ **from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../modules/internal-8.md#buffer) + +Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`. +Array entries outside that range will be truncated to fit into it. + +```js +import { Buffer } from 'node:buffer'; + +// Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'. +const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]); +``` + +If `array` is an `Array`\-like object (that is, one with a `length` property of +type `number`), it is treated as if it is an array, unless it is a `Buffer` or +a `Uint8Array`. This means all other `TypedArray` variants get treated as an`Array`. To create a `Buffer` from the bytes backing a `TypedArray`, use `Buffer.copyBytesFrom()`. + +A `TypeError` will be thrown if `array` is not an `Array` or another type +appropriate for `Buffer.from()` variants. + +`Buffer.from(array)` and `Buffer.from(string)` may also use the internal`Buffer` pool like `Buffer.allocUnsafe()` does. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `arrayBuffer` | [`WithImplicitCoercion`](../modules/internal-8.md#withimplicitcoercion)<`ArrayBuffer` \| [`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer)\> | +| `byteOffset?` | `number` | +| `length?` | `number` | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +**`Since`** + +v5.10.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:312 + +▸ **from**(`data`): [`Buffer`](../modules/internal-8.md#buffer) + +Creates a new Buffer using the passed {data} + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `Uint8Array` \| readonly `number`[] | data to create a new Buffer | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:321 + +▸ **from**(`data`): [`Buffer`](../modules/internal-8.md#buffer) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`WithImplicitCoercion`](../modules/internal-8.md#withimplicitcoercion)<`string` \| `Uint8Array` \| readonly `number`[]\> | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:322 + +▸ **from**(`str`, `encoding?`): [`Buffer`](../modules/internal-8.md#buffer) + +Creates a new Buffer containing the given JavaScript string {str}. +If provided, the {encoding} parameter identifies the character encoding. +If not provided, {encoding} defaults to 'utf8'. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | [`WithImplicitCoercion`](../modules/internal-8.md#withimplicitcoercion)<`string`\> \| { `[toPrimitive]`: (`hint`: ``"string"``) => `string` } | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:328 + +___ + +### isBuffer + +▸ **isBuffer**(`obj`): obj is Buffer + +Returns `true` if `obj` is a `Buffer`, `false` otherwise. + +```js +import { Buffer } from 'node:buffer'; + +Buffer.isBuffer(Buffer.alloc(10)); // true +Buffer.isBuffer(Buffer.from('foo')); // true +Buffer.isBuffer('a string'); // false +Buffer.isBuffer([]); // false +Buffer.isBuffer(new Uint8Array(1024)); // false +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `any` | + +#### Returns + +obj is Buffer + +**`Since`** + +v0.1.101 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:355 + +___ + +### isEncoding + +▸ **isEncoding**(`encoding`): encoding is BufferEncoding + +Returns `true` if `encoding` is the name of a supported character encoding, +or `false` otherwise. + +```js +import { Buffer } from 'node:buffer'; + +console.log(Buffer.isEncoding('utf8')); +// Prints: true + +console.log(Buffer.isEncoding('hex')); +// Prints: true + +console.log(Buffer.isEncoding('utf/8')); +// Prints: false + +console.log(Buffer.isEncoding('')); +// Prints: false +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `encoding` | `string` | A character encoding name to check. | + +#### Returns + +encoding is BufferEncoding + +**`Since`** + +v0.9.1 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:378 + +___ + +### of + +▸ **of**(`...items`): [`Buffer`](../modules/internal-8.md#buffer) + +Creates a new Buffer using the passed {data} + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...items` | `number`[] | + +#### Returns + +[`Buffer`](../modules/internal-8.md#buffer) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:340 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md new file mode 100644 index 0000000000..af4745d732 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.CallSite.md @@ -0,0 +1,222 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CallSite + +[internal](../modules/internal-8.md).CallSite + +## Methods + +### getColumnNumber + +▸ **getColumnNumber**(): ``null`` \| `number` + +Current column number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:173 + +___ + +### getEvalOrigin + +▸ **getEvalOrigin**(): `undefined` \| `string` + +A call site object representing the location where eval was called +[if this function was created using a call to eval] + +#### Returns + +`undefined` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:179 + +___ + +### getFileName + +▸ **getFileName**(): `undefined` \| `string` + +Name of the script [if this function was defined in a script] + +#### Returns + +`undefined` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:163 + +___ + +### getFunction + +▸ **getFunction**(): `undefined` \| `Function` + +Current function + +#### Returns + +`undefined` \| `Function` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:145 + +___ + +### getFunctionName + +▸ **getFunctionName**(): ``null`` \| `string` + +Name of the current function, typically its name property. +If a name property is not available an attempt will be made to try +to infer a name from the function's context. + +#### Returns + +``null`` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:152 + +___ + +### getLineNumber + +▸ **getLineNumber**(): ``null`` \| `number` + +Current line number [if this function was defined in a script] + +#### Returns + +``null`` \| `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:168 + +___ + +### getMethodName + +▸ **getMethodName**(): ``null`` \| `string` + +Name of the property [of "this" or one of its prototypes] that holds +the current function + +#### Returns + +``null`` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:158 + +___ + +### getThis + +▸ **getThis**(): `unknown` + +Value of "this" + +#### Returns + +`unknown` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:132 + +___ + +### getTypeName + +▸ **getTypeName**(): ``null`` \| `string` + +Type of "this" as a string. +This is the name of the function stored in the constructor field of +"this", if available. Otherwise the object's [[Class]] internal +property. + +#### Returns + +``null`` \| `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:140 + +___ + +### isConstructor + +▸ **isConstructor**(): `boolean` + +Is this a constructor call? + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:199 + +___ + +### isEval + +▸ **isEval**(): `boolean` + +Does this call take place in code defined by a call to eval? + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:189 + +___ + +### isNative + +▸ **isNative**(): `boolean` + +Is this call in native V8 code? + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:194 + +___ + +### isToplevel + +▸ **isToplevel**(): `boolean` + +Is this a toplevel invocation, that is, is "this" the global object? + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:184 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md new file mode 100644 index 0000000000..a2b704ae77 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateNoteInput.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CreateNoteInput + +[internal](../modules/internal-8.md).CreateNoteInput + +## Properties + +### author + +• `Optional` **author**: [`User`](../classes/internal-1.User.md) + +#### Defined in + +packages/medusa/dist/types/note.d.ts:9 + +___ + +### author\_id + +• `Optional` **author\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/note.d.ts:8 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/types/note.d.ts:10 + +___ + +### resource\_id + +• **resource\_id**: `string` + +#### Defined in + +packages/medusa/dist/types/note.d.ts:7 + +___ + +### resource\_type + +• **resource\_type**: `string` + +#### Defined in + +packages/medusa/dist/types/note.d.ts:6 + +___ + +### value + +• **value**: `string` + +#### Defined in + +packages/medusa/dist/types/note.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md new file mode 100644 index 0000000000..496ef9dce6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.CreateUserInput.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CreateUserInput + +[internal](../modules/internal-8.md).CreateUserInput + +## Properties + +### api\_token + +• `Optional` **api\_token**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:8 + +___ + +### email + +• **email**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:5 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:6 + +___ + +### id + +• `Optional` **id**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:4 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:7 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/types/user.d.ts:10 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/types/user.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md new file mode 100644 index 0000000000..2ea178543b --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.DuplexOptions.md @@ -0,0 +1,345 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: DuplexOptions + +[internal](../modules/internal-8.md).DuplexOptions + +## Hierarchy + +- [`ReadableOptions`](internal-8.internal-2.ReadableOptions.md) + +- [`WritableOptions`](internal-8.internal-2.WritableOptions.md) + + ↳ **`DuplexOptions`** + + ↳↳ [`TransformOptions`](internal-8.TransformOptions.md) + +## Properties + +### allowHalfOpen + +• `Optional` **allowHalfOpen**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:831 + +___ + +### autoDestroy + +• `Optional` **autoDestroy**: `boolean` + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[autoDestroy](internal-8.internal-2.WritableOptions.md#autodestroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:776 + +___ + +### decodeStrings + +• `Optional` **decodeStrings**: `boolean` + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[decodeStrings](internal-8.internal-2.WritableOptions.md#decodestrings) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:800 + +___ + +### defaultEncoding + +• `Optional` **defaultEncoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[defaultEncoding](internal-8.internal-2.WritableOptions.md#defaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:801 + +___ + +### emitClose + +• `Optional` **emitClose**: `boolean` + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[emitClose](internal-8.internal-2.WritableOptions.md#emitclose) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:771 + +___ + +### encoding + +• `Optional` **encoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Inherited from + +[ReadableOptions](internal-8.internal-2.ReadableOptions.md).[encoding](internal-8.internal-2.ReadableOptions.md#encoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:779 + +___ + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[highWaterMark](internal-8.internal-2.WritableOptions.md#highwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:772 + +___ + +### objectMode + +• `Optional` **objectMode**: `boolean` + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[objectMode](internal-8.internal-2.WritableOptions.md#objectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:773 + +___ + +### readableHighWaterMark + +• `Optional` **readableHighWaterMark**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:834 + +___ + +### readableObjectMode + +• `Optional` **readableObjectMode**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:832 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[signal](internal-8.internal-2.WritableOptions.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +___ + +### writableCorked + +• `Optional` **writableCorked**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:836 + +___ + +### writableHighWaterMark + +• `Optional` **writableHighWaterMark**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:835 + +___ + +### writableObjectMode + +• `Optional` **writableObjectMode**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:833 + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[construct](internal-8.internal-2.WritableOptions.md#construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:837 + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[destroy](internal-8.internal-2.WritableOptions.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:849 + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[final](internal-8.internal-2.WritableOptions.md#final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:848 + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `size` | `number` | + +#### Returns + +`void` + +#### Overrides + +[ReadableOptions](internal-8.internal-2.ReadableOptions.md).[read](internal-8.internal-2.ReadableOptions.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:838 + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[write](internal-8.internal-2.WritableOptions.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:839 + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Duplex`](../classes/internal-8.Duplex.md) | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[WritableOptions](internal-8.internal-2.WritableOptions.md).[writev](internal-8.internal-2.WritableOptions.md#writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:840 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md new file mode 100644 index 0000000000..935a30eb8f --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ErrnoException.md @@ -0,0 +1,95 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ErrnoException + +[internal](../modules/internal-8.md).ErrnoException + +## Hierarchy + +- [`Error`](../modules/internal-8.md#error) + + ↳ **`ErrnoException`** + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:204 + +___ + +### errno + +• `Optional` **errno**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:203 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: `string` + +#### Inherited from + +Error.name + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### path + +• `Optional` **path**: `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:205 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### syscall + +• `Optional` **syscall**: `string` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:206 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md new file mode 100644 index 0000000000..0868cea02d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Error.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Error + +[internal](../modules/internal-8.md).Error + +## Properties + +### message + +• **message**: `string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: `string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1067 + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1069 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md new file mode 100644 index 0000000000..909ac68f7a --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter-2.md @@ -0,0 +1,649 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: EventEmitter + +[internal](../modules/internal-8.md).EventEmitter + +## Hierarchy + +- **`EventEmitter`** + + ↳ [`ReadableStream`](internal-8.ReadableStream.md) + + ↳ [`WritableStream`](internal-8.WritableStream.md) + + ↳ [`EventEmitter`](../classes/internal-8.EventEmitter-1.md) + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.1.26 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v10.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.1.101 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.3.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v6.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v6.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.1.26 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.1.26 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`EventEmitter`](internal-8.EventEmitter-2.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`EventEmitter`](internal-8.EventEmitter-2.md) + +**`Since`** + +v0.3.5 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md new file mode 100644 index 0000000000..dbef089527 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitter.Abortable.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Abortable + +[internal](../modules/internal-8.md).[EventEmitter](../modules/internal-8.EventEmitter.md).Abortable + +## Hierarchy + +- **`Abortable`** + + ↳ [`StreamOptions`](internal-8.internal-2.StreamOptions.md) + + ↳ [`FinishedOptions`](internal-8.internal-2.FinishedOptions.md) + +## Properties + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md new file mode 100644 index 0000000000..409299f482 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.EventEmitterOptions.md @@ -0,0 +1,19 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: EventEmitterOptions + +[internal](../modules/internal-8.md).EventEmitterOptions + +## Properties + +### captureRejections + +• `Optional` **captureRejections**: `boolean` + +Enables automatic capturing of promise rejection. + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:75 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md new file mode 100644 index 0000000000..ce259476f6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.FindConfig.md @@ -0,0 +1,94 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FindConfig + +[internal](../modules/internal-8.md).FindConfig + +An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class, +which provides correct typing of field names in its properties. + +## Type parameters + +| Name | +| :------ | +| `Entity` | + +## Properties + +### order + +• `Optional` **order**: `Object` + +An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` +to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order. + +#### Index signature + +▪ [K: `string`]: ``"ASC"`` \| ``"DESC"`` + +#### Defined in + +packages/types/dist/common/common.d.ts:45 + +___ + +### relations + +• `Optional` **relations**: `string`[] + +An array of strings, each being relation names of the entity to retrieve in the result. + +#### Defined in + +packages/types/dist/common/common.d.ts:44 + +___ + +### select + +• `Optional` **select**: (`string` \| keyof `Entity`)[] + +An array of strings, each being attribute names of the entity to retrieve in the result. + +#### Defined in + +packages/types/dist/common/common.d.ts:41 + +___ + +### skip + +• `Optional` **skip**: `number` + +A number indicating the number of records to skip before retrieving the results. + +#### Defined in + +packages/types/dist/common/common.d.ts:42 + +___ + +### take + +• `Optional` **take**: `number` + +A number indicating the number of records to return in the result. + +#### Defined in + +packages/types/dist/common/common.d.ts:43 + +___ + +### withDeleted + +• `Optional` **withDeleted**: `boolean` + +A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the +`SoftDeletableEntity` class. + +#### Defined in + +packages/types/dist/common/common.d.ts:48 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md new file mode 100644 index 0000000000..956870bbb3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ICacheService.md @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ICacheService + +[internal](../modules/internal-8.md).ICacheService + +## Methods + +### get + +▸ **get**<`T`\>(`key`): `Promise`<``null`` \| `T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`Promise`<``null`` \| `T`\> + +#### Defined in + +packages/types/dist/cache/service.d.ts:2 + +___ + +### invalidate + +▸ **invalidate**(`key`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/cache/service.d.ts:4 + +___ + +### set + +▸ **set**(`key`, `data`, `ttl?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `data` | `unknown` | +| `ttl?` | `number` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/cache/service.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md new file mode 100644 index 0000000000..0deedbbe70 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusModuleService.md @@ -0,0 +1,105 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IEventBusModuleService + +[internal](../modules/internal-8.md).IEventBusModuleService + +## Implemented by + +- [`AbstractEventBusModuleService`](../classes/internal-8.AbstractEventBusModuleService.md) + +## Methods + +### emit + +▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` | +| `data` | `T` | +| `options?` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/event-bus/event-bus-module.d.ts:3 + +▸ **emit**<`T`\>(`data`): `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`EmitData`](../modules/internal-8.md#emitdata)<`T`\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/event-bus/event-bus-module.d.ts:4 + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](internal-8.IEventBusModuleService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber) | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`IEventBusModuleService`](internal-8.IEventBusModuleService.md) + +#### Defined in + +packages/types/dist/event-bus/event-bus-module.d.ts:5 + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusModuleService`](internal-8.IEventBusModuleService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber) | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`IEventBusModuleService`](internal-8.IEventBusModuleService.md) + +#### Defined in + +packages/types/dist/event-bus/event-bus-module.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md new file mode 100644 index 0000000000..34c3cac667 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IEventBusService.md @@ -0,0 +1,113 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IEventBusService + +[internal](../modules/internal-8.md).IEventBusService + +## Hierarchy + +- [`ITransactionBaseService`](internal-8.ITransactionBaseService.md) + + ↳ **`IEventBusService`** + +## Implemented by + +- [`EventBusService`](../classes/internal-8.internal.EventBusService.md) + +## Methods + +### emit + +▸ **emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` | +| `data` | `T` | +| `options?` | `unknown` | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +packages/types/dist/event-bus/event-bus.d.ts:6 + +___ + +### subscribe + +▸ **subscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](internal-8.IEventBusService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber) | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`IEventBusService`](internal-8.IEventBusService.md) + +#### Defined in + +packages/types/dist/event-bus/event-bus.d.ts:4 + +___ + +### unsubscribe + +▸ **unsubscribe**(`eventName`, `subscriber`, `context?`): [`IEventBusService`](internal-8.IEventBusService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `subscriber` | [`Subscriber`](../modules/internal-8.md#subscriber) | +| `context?` | [`SubscriberContext`](../modules/internal-8.md#subscribercontext) | + +#### Returns + +[`IEventBusService`](internal-8.IEventBusService.md) + +#### Defined in + +packages/types/dist/event-bus/event-bus.d.ts:5 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IEventBusService`](internal-8.IEventBusService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`IEventBusService`](internal-8.IEventBusService.md) + +#### Inherited from + +[ITransactionBaseService](internal-8.ITransactionBaseService.md).[withTransaction](internal-8.ITransactionBaseService.md#withtransaction) + +#### Defined in + +packages/types/dist/transaction-base/transaction-base.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md new file mode 100644 index 0000000000..97e3d7f7a5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IFlagRouter.md @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IFlagRouter + +[internal](../modules/internal-8.md).IFlagRouter + +## Implemented by + +- [`FlagRouter`](../classes/internal-8.FlagRouter.md) + +## Properties + +### isFeatureEnabled + +• **isFeatureEnabled**: (`key`: `string`) => `boolean` + +#### Type declaration + +▸ (`key`): `boolean` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `key` | `string` | + +##### Returns + +`boolean` + +#### Defined in + +packages/types/dist/feature-flag/common.d.ts:2 + +___ + +### listFlags + +• **listFlags**: () => [`FeatureFlagsResponse`](../modules/internal-8.md#featureflagsresponse-1) + +#### Type declaration + +▸ (): [`FeatureFlagsResponse`](../modules/internal-8.md#featureflagsresponse-1) + +##### Returns + +[`FeatureFlagsResponse`](../modules/internal-8.md#featureflagsresponse-1) + +#### Defined in + +packages/types/dist/feature-flag/common.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md new file mode 100644 index 0000000000..780f02b21c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IInventoryService.md @@ -0,0 +1,605 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IInventoryService + +[internal](../modules/internal-8.md).IInventoryService + +## Methods + +### \_\_joinerConfig + +▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../modules/internal-8.md#modulejoinerconfig) + +#### Returns + +[`ModuleJoinerConfig`](../modules/internal-8.md#modulejoinerconfig) + +#### Defined in + +packages/types/dist/inventory/service.d.ts:6 + +___ + +### adjustInventory + +▸ **adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationId` | `string` | +| `adjustment` | `number` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:32 + +___ + +### confirmInventory + +▸ **confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationIds` | `string`[] | +| `quantity` | `number` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:33 + +___ + +### createInventoryItem + +▸ **createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | [`CreateInventoryItemInput`](../modules/internal-8.md#createinventoryiteminput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:15 + +___ + +### createInventoryItems + +▸ **createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | [`CreateInventoryItemInput`](../modules/internal-8.md#createinventoryiteminput)[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:16 + +___ + +### createInventoryLevel + +▸ **createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateInventoryLevelInput`](../modules/internal-8.md#createinventorylevelinput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:17 + +___ + +### createInventoryLevels + +▸ **createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`CreateInventoryLevelInput`](../modules/internal-8.md#createinventorylevelinput)[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:18 + +___ + +### createReservationItem + +▸ **createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | [`CreateReservationItemInput`](../modules/internal-8.md#createreservationiteminput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:13 + +___ + +### createReservationItems + +▸ **createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | [`CreateReservationItemInput`](../modules/internal-8.md#createreservationiteminput)[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:14 + +___ + +### deleteInventoryItem + +▸ **deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` \| `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:28 + +___ + +### deleteInventoryItemLevelByLocationId + +▸ **deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `locationId` | `string` \| `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:29 + +___ + +### deleteInventoryLevel + +▸ **deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryLevelId` | `string` | +| `locationId` | `string` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:31 + +___ + +### deleteReservationItem + +▸ **deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reservationItemId` | `string` \| `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:27 + +___ + +### deleteReservationItemByLocationId + +▸ **deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `locationId` | `string` \| `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:30 + +___ + +### deleteReservationItemsByLineItem + +▸ **deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `lineItemId` | `string` \| `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:26 + +___ + +### listInventoryItems + +▸ **listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableInventoryItemProps`](../modules/internal-8.md#filterableinventoryitemprops) | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)[], `number`]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:7 + +___ + +### listInventoryLevels + +▸ **listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableInventoryLevelProps`](../modules/internal-8.md#filterableinventorylevelprops) | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[], `number`]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:9 + +___ + +### listReservationItems + +▸ **listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableReservationItemProps`](../modules/internal-8.md#filterablereservationitemprops) | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)[], `number`]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:8 + +___ + +### retrieveAvailableQuantity + +▸ **retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationIds` | `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:34 + +___ + +### retrieveInventoryItem + +▸ **retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:10 + +___ + +### retrieveInventoryLevel + +▸ **retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationId` | `string` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:11 + +___ + +### retrieveReservationItem + +▸ **retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reservationId` | `string` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:12 + +___ + +### retrieveReservedQuantity + +▸ **retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationIds` | `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:36 + +___ + +### retrieveStockedQuantity + +▸ **retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationIds` | `string`[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:35 + +___ + +### updateInventoryItem + +▸ **updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `input` | [`CreateInventoryItemInput`](../modules/internal-8.md#createinventoryiteminput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryItemDTO`](../modules/internal-8.md#inventoryitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:24 + +___ + +### updateInventoryLevel + +▸ **updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inventoryItemId` | `string` | +| `locationId` | `string` | +| `update` | [`UpdateInventoryLevelInput`](../modules/internal-8.md#updateinventorylevelinput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:23 + +___ + +### updateInventoryLevels + +▸ **updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `updates` | { `inventory_item_id`: `string` ; `location_id`: `string` } & [`UpdateInventoryLevelInput`](../modules/internal-8.md#updateinventorylevelinput)[] | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`InventoryLevelDTO`](../modules/internal-8.md#inventoryleveldto)[]\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:19 + +___ + +### updateReservationItem + +▸ **updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reservationItemId` | `string` | +| `input` | [`UpdateReservationItemInput`](../modules/internal-8.md#updatereservationiteminput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`ReservationItemDTO`](../modules/internal-8.md#reservationitemdto)\> + +#### Defined in + +packages/types/dist/inventory/service.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md new file mode 100644 index 0000000000..a9f6c84a7c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ISearchService.md @@ -0,0 +1,222 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ISearchService + +[internal](../modules/internal-8.md).ISearchService + +## Implemented by + +- [`AbstractSearchService`](../classes/internal-8.AbstractSearchService.md) + +## Properties + +### options + +• **options**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/types/dist/search/interface.d.ts:2 + +## Methods + +### addDocuments + +▸ **addDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to index documents by the search engine provider + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `documents` | `unknown` | documents array to be indexed | +| `type` | `string` | of documents to be added (e.g: products, regions, orders, etc) | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:23 + +___ + +### createIndex + +▸ **createIndex**(`indexName`, `options`): `unknown` + +Used to create an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `options` | `unknown` | the options | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:9 + +___ + +### deleteAllDocuments + +▸ **deleteAllDocuments**(`indexName`): `unknown` + +Used to delete all documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:44 + +___ + +### deleteDocument + +▸ **deleteDocument**(`indexName`, `document_id`): `unknown` + +Used to delete document + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `document_id` | `string` \| `number` | the id of the document | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:38 + +___ + +### getIndex + +▸ **getIndex**(`indexName`): `unknown` + +Used to get an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:15 + +___ + +### replaceDocuments + +▸ **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` + +Used to replace documents + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name. | +| `documents` | `unknown` | array of document objects that will replace existing documents | +| `type` | `string` | type of documents to be replaced (e.g: products, regions, orders, etc) | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:31 + +___ + +### search + +▸ **search**(`indexName`, `query`, `options`): `unknown` + +Used to search for a document in an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `query` | ``null`` \| `string` | the search query | +| `options` | `unknown` | any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:54 + +___ + +### updateSettings + +▸ **updateSettings**(`indexName`, `settings`): `unknown` + +Used to update the settings of an index + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `indexName` | `string` | the index name | +| `settings` | `unknown` | settings object | + +#### Returns + +`unknown` + +returns response from search engine provider + +#### Defined in + +packages/types/dist/search/interface.d.ts:61 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md new file mode 100644 index 0000000000..ea146ce837 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IStockLocationService.md @@ -0,0 +1,151 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IStockLocationService + +[internal](../modules/internal-8.md).IStockLocationService + +## Methods + +### \_\_joinerConfig + +▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../modules/internal-8.md#modulejoinerconfig) + +#### Returns + +[`ModuleJoinerConfig`](../modules/internal-8.md#modulejoinerconfig) + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:6 + +___ + +### create + +▸ **create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | [`CreateStockLocationInput`](../modules/internal-8.md#createstocklocationinput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:10 + +___ + +### delete + +▸ **delete**(`id`, `context?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:12 + +___ + +### list + +▸ **list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableStockLocationProps`](../modules/internal-8.md#filterablestocklocationprops) | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)[]\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:7 + +___ + +### listAndCount + +▸ **listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)[], `number`]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `selector` | [`FilterableStockLocationProps`](../modules/internal-8.md#filterablestocklocationprops) | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)[], `number`]\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:8 + +___ + +### retrieve + +▸ **retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `config?` | [`FindConfig`](internal-8.FindConfig.md)<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:9 + +___ + +### update + +▸ **update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `input` | [`UpdateStockLocationInput`](../modules/internal-8.md#updatestocklocationinput) | +| `context?` | [`SharedContext`](../modules/internal-8.md#sharedcontext) | + +#### Returns + +`Promise`<[`StockLocationDTO`](../modules/internal-8.md#stocklocationdto)\> + +#### Defined in + +packages/types/dist/stock-location/service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md new file mode 100644 index 0000000000..c264e85d98 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ITransactionBaseService.md @@ -0,0 +1,35 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ITransactionBaseService + +[internal](../modules/internal-8.md).ITransactionBaseService + +## Hierarchy + +- **`ITransactionBaseService`** + + ↳ [`IPriceSelectionStrategy`](internal-8.internal.IPriceSelectionStrategy.md) + + ↳ [`IEventBusService`](internal-8.IEventBusService.md) + +## Methods + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`ITransactionBaseService`](internal-8.ITransactionBaseService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`ITransactionBaseService`](internal-8.ITransactionBaseService.md) + +#### Defined in + +packages/types/dist/transaction-base/transaction-base.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md new file mode 100644 index 0000000000..a2c3adea0c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterable.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Iterable + +[internal](../modules/internal-8.md).Iterable + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`Iterator`](internal-8.Iterator.md)<`T`, `any`, `undefined`\> + +#### Returns + +[`Iterator`](internal-8.Iterator.md)<`T`, `any`, `undefined`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:49 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md new file mode 100644 index 0000000000..7699ddc8f1 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IterableIterator.md @@ -0,0 +1,105 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IterableIterator + +[internal](../modules/internal-8.md).IterableIterator + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Hierarchy + +- [`Iterator`](internal-8.Iterator.md)<`T`\> + + ↳ **`IterableIterator`** + +## Methods + +### [iterator] + +▸ **[iterator]**(): [`IterableIterator`](internal-8.IterableIterator.md)<`T`\> + +#### Returns + +[`IterableIterator`](internal-8.IterableIterator.md)<`T`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:53 + +___ + +### next + +▸ **next**(`...args`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`undefined`] | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Inherited from + +[Iterator](internal-8.Iterator.md).[next](internal-8.Iterator.md#next) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:43 + +___ + +### return + +▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `any` | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Inherited from + +[Iterator](internal-8.Iterator.md).[return](internal-8.Iterator.md#return) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:44 + +___ + +### throw + +▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `any`\> + +#### Inherited from + +[Iterator](internal-8.Iterator.md).[throw](internal-8.Iterator.md#throw) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md new file mode 100644 index 0000000000..ad0a9a41e0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Iterator.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Iterator + +[internal](../modules/internal-8.md).Iterator + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `TReturn` | `any` | +| `TNext` | `undefined` | + +## Hierarchy + +- **`Iterator`** + + ↳ [`IterableIterator`](internal-8.IterableIterator.md) + +## Methods + +### next + +▸ **next**(`...args`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | [] \| [`TNext`] | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:43 + +___ + +### return + +▸ `Optional` **return**(`value?`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `TReturn` | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:44 + +___ + +### throw + +▸ `Optional` **throw**(`e?`): [`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +[`IteratorResult`](../modules/internal-8.md#iteratorresult)<`T`, `TReturn`\> + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:45 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md new file mode 100644 index 0000000000..93f46022b7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorReturnResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IteratorReturnResult + +[internal](../modules/internal-8.md).IteratorReturnResult + +## Type parameters + +| Name | +| :------ | +| `TReturn` | + +## Properties + +### done + +• **done**: ``true`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:35 + +___ + +### value + +• **value**: `TReturn` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:36 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md new file mode 100644 index 0000000000..7109db3956 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.IteratorYieldResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IteratorYieldResult + +[internal](../modules/internal-8.md).IteratorYieldResult + +## Type parameters + +| Name | +| :------ | +| `TYield` | + +## Properties + +### done + +• `Optional` **done**: ``false`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:30 + +___ + +### value + +• **value**: `TYield` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:31 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md new file mode 100644 index 0000000000..4f0ababf4d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfig.md @@ -0,0 +1,83 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: JoinerServiceConfig + +[internal](../modules/internal-8.md).JoinerServiceConfig + +## Properties + +### alias + +• `Optional` **alias**: [`JoinerServiceConfigAlias`](internal-8.JoinerServiceConfigAlias.md) \| [`JoinerServiceConfigAlias`](internal-8.JoinerServiceConfigAlias.md)[] + +Property name to use as entrypoint to the service + +#### Defined in + +packages/types/dist/joiner/index.d.ts:36 + +___ + +### args + +• `Optional` **args**: [`Record`](../modules/internal.md#record)<`string`, `any`\> + +Extra arguments to pass to the remoteFetchData callback + +#### Defined in + +packages/types/dist/joiner/index.d.ts:53 + +___ + +### extends + +• `Optional` **extends**: { `relationship`: [`JoinerRelationship`](../modules/internal-8.md#joinerrelationship) ; `serviceName`: `string` }[] + +#### Defined in + +packages/types/dist/joiner/index.d.ts:46 + +___ + +### fieldAlias + +• `Optional` **fieldAlias**: [`Record`](../modules/internal.md#record)<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> + +alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' }) + +#### Defined in + +packages/types/dist/joiner/index.d.ts:40 + +___ + +### primaryKeys + +• **primaryKeys**: `string`[] + +#### Defined in + +packages/types/dist/joiner/index.d.ts:44 + +___ + +### relationships + +• `Optional` **relationships**: [`JoinerRelationship`](../modules/internal-8.md#joinerrelationship)[] + +#### Defined in + +packages/types/dist/joiner/index.d.ts:45 + +___ + +### serviceName + +• **serviceName**: `string` + +#### Defined in + +packages/types/dist/joiner/index.d.ts:32 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md new file mode 100644 index 0000000000..143e43e5f5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.JoinerServiceConfigAlias.md @@ -0,0 +1,29 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: JoinerServiceConfigAlias + +[internal](../modules/internal-8.md).JoinerServiceConfigAlias + +## Properties + +### args + +• `Optional` **args**: [`Record`](../modules/internal.md#record)<`string`, `any`\> + +Extra arguments to pass to the remoteFetchData callback + +#### Defined in + +packages/types/dist/joiner/index.d.ts:29 + +___ + +### name + +• **name**: `string` + +#### Defined in + +packages/types/dist/joiner/index.d.ts:25 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md new file mode 100644 index 0000000000..5014456a13 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Logger.md @@ -0,0 +1,318 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Logger + +[internal](../modules/internal-8.md).Logger + +## Properties + +### activity + +• **activity**: (`message`: `string`, `config?`: `any`) => `void` + +#### Type declaration + +▸ (`message`, `config?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `string` | +| `config?` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:6 + +___ + +### debug + +• **debug**: (`message`: `any`) => `void` + +#### Type declaration + +▸ (`message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:11 + +___ + +### error + +• **error**: (`messageOrError`: `any`, `error?`: `any`) => `void` + +#### Type declaration + +▸ (`messageOrError`, `error?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `messageOrError` | `any` | +| `error?` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:8 + +___ + +### failure + +• **failure**: (`activityId`: `any`, `message`: `any`) => `void` + +#### Type declaration + +▸ (`activityId`, `message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `activityId` | `any` | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:9 + +___ + +### info + +• **info**: (`message`: `any`) => `void` + +#### Type declaration + +▸ (`message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:12 + +___ + +### log + +• **log**: (...`args`: `any`[]) => `void` + +#### Type declaration + +▸ (`...args`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any`[] | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:14 + +___ + +### panic + +• **panic**: (`data`: `any`) => `void` + +#### Type declaration + +▸ (`data`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:2 + +___ + +### progress + +• **progress**: (`activityId`: `any`, `message`: `any`) => `void` + +#### Type declaration + +▸ (`activityId`, `message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `activityId` | `any` | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:7 + +___ + +### setLogLevel + +• **setLogLevel**: (`level`: `string`) => `void` + +#### Type declaration + +▸ (`level`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `level` | `string` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:4 + +___ + +### shouldLog + +• **shouldLog**: (`level`: `string`) => `void` + +#### Type declaration + +▸ (`level`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `level` | `string` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:3 + +___ + +### success + +• **success**: (`activityId`: `any`, `message`: `any`) => `void` + +#### Type declaration + +▸ (`activityId`, `message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `activityId` | `any` | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:10 + +___ + +### unsetLogLevel + +• **unsetLogLevel**: () => `void` + +#### Type declaration + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:5 + +___ + +### warn + +• **warn**: (`message`: `any`) => `void` + +#### Type declaration + +▸ (`message`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `message` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/types/dist/logger/index.d.ts:13 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md new file mode 100644 index 0000000000..ec468f2df2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.NumericalComparisonOperator.md @@ -0,0 +1,47 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: NumericalComparisonOperator + +[internal](../modules/internal-8.md).NumericalComparisonOperator + +## Properties + +### gt + +• `Optional` **gt**: `number` + +#### Defined in + +packages/types/dist/common/common.d.ts:123 + +___ + +### gte + +• `Optional` **gte**: `number` + +#### Defined in + +packages/types/dist/common/common.d.ts:124 + +___ + +### lt + +• `Optional` **lt**: `number` + +#### Defined in + +packages/types/dist/common/common.d.ts:122 + +___ + +### lte + +• `Optional` **lte**: `number` + +#### Defined in + +packages/types/dist/common/common.d.ts:125 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md new file mode 100644 index 0000000000..e6a8a09a5c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.Object.md @@ -0,0 +1,133 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Object + +[internal](../modules/internal-8.md).Object + +## Properties + +### constructor + +• **constructor**: `Function` + +The initial value of Object.prototype.constructor is the standard built-in Object constructor. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:125 + +## Methods + +### hasOwnProperty + +▸ **hasOwnProperty**(`v`): `boolean` + +Determines whether an object has a property with the specified name. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `v` | [`PropertyKey`](../modules/internal-8.md#propertykey) | A property name. | + +#### Returns + +`boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:140 + +___ + +### isPrototypeOf + +▸ **isPrototypeOf**(`v`): `boolean` + +Determines whether an object exists in another object's prototype chain. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `v` | [`Object`](../modules/internal-8.md#object) | Another object whose prototype chain is to be checked. | + +#### Returns + +`boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:146 + +___ + +### propertyIsEnumerable + +▸ **propertyIsEnumerable**(`v`): `boolean` + +Determines whether a specified property is enumerable. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `v` | [`PropertyKey`](../modules/internal-8.md#propertykey) | A property name. | + +#### Returns + +`boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:152 + +___ + +### toLocaleString + +▸ **toLocaleString**(): `string` + +Returns a date converted to a string using the current locale. + +#### Returns + +`string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:131 + +___ + +### toString + +▸ **toString**(): `string` + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:128 + +___ + +### valueOf + +▸ **valueOf**(): [`Object`](../modules/internal-8.md#object) + +Returns the primitive value of the specified object. + +#### Returns + +[`Object`](../modules/internal-8.md#object) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:134 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md new file mode 100644 index 0000000000..80e3678bda --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.PromiseLike.md @@ -0,0 +1,45 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PromiseLike + +[internal](../modules/internal-8.md).PromiseLike + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Methods + +### then + +▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](internal-8.PromiseLike.md)<`TResult1` \| `TResult2`\> + +Attaches callbacks for the resolution and/or rejection of the Promise. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TResult1` | `T` | +| `TResult2` | `never` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TResult1`\> | The callback to execute when the Promise is resolved. | +| `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| [`PromiseLike`](internal-8.PromiseLike.md)<`TResult2`\> | The callback to execute when the Promise is rejected. | + +#### Returns + +[`PromiseLike`](internal-8.PromiseLike.md)<`TResult1` \| `TResult2`\> + +A Promise for the completion of which ever callback is executed. + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1529 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md new file mode 100644 index 0000000000..5d56a92f9f --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategy.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: QueuingStrategy + +[internal](../modules/internal-8.md).QueuingStrategy + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Properties + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:254 + +___ + +### size + +• `Optional` **size**: [`QueuingStrategySize`](internal-8.QueuingStrategySize.md)<`T`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:255 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md new file mode 100644 index 0000000000..11bb2e825c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.QueuingStrategySize.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: QueuingStrategySize + +[internal](../modules/internal-8.md).QueuingStrategySize + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +## Callable + +### QueuingStrategySize + +▸ **QueuingStrategySize**(`chunk?`): `number` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk?` | `T` | + +#### Returns + +`number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:258 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md new file mode 100644 index 0000000000..b7503e2ebc --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadWriteStream.md @@ -0,0 +1,1074 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadWriteStream + +[internal](../modules/internal-8.md).ReadWriteStream + +## Hierarchy + +- [`ReadableStream`](internal-8.ReadableStream.md) + +- [`WritableStream`](internal-8.WritableStream.md) + + ↳ **`ReadWriteStream`** + +## Properties + +### readable + +• **readable**: `boolean` + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[readable](internal-8.ReadableStream.md#readable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:210 + +___ + +### writable + +• **writable**: `boolean` + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[writable](internal-8.WritableStream.md#writable) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:224 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\> + +#### Returns + +[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\> + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[[asyncIterator]](internal-8.ReadableStream.md#[asynciterator]) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:220 + +___ + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[addListener](internal-8.WritableStream.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[emit](internal-8.WritableStream.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### end + +▸ **end**(`cb?`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[end](internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:227 + +▸ **end**(`data`, `cb?`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `string` \| `Uint8Array` | +| `cb?` | () => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[end](internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:228 + +▸ **end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[end](internal-8.WritableStream.md#end) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:229 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[eventNames](internal-8.WritableStream.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[getMaxListeners](internal-8.WritableStream.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[isPaused](internal-8.ReadableStream.md#ispaused) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:215 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[listenerCount](internal-8.WritableStream.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[listeners](internal-8.WritableStream.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[off](internal-8.WritableStream.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[on](internal-8.WritableStream.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[once](internal-8.WritableStream.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### pause + +▸ **pause**(): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[pause](internal-8.ReadableStream.md#pause) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:213 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[pipe](internal-8.ReadableStream.md#pipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:216 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[prependListener](internal-8.WritableStream.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[prependOnceListener](internal-8.WritableStream.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[rawListeners](internal-8.WritableStream.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `string` \| [`Buffer`](../modules/internal-8.md#buffer) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size?` | `number` | + +#### Returns + +`string` \| [`Buffer`](../modules/internal-8.md#buffer) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[read](internal-8.ReadableStream.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:211 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[removeAllListeners](internal-8.WritableStream.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[removeListener](internal-8.WritableStream.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### resume + +▸ **resume**(): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[resume](internal-8.ReadableStream.md#resume) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:214 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[setEncoding](internal-8.ReadableStream.md#setencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:212 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[setMaxListeners](internal-8.WritableStream.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination?` | [`WritableStream`](internal-8.WritableStream.md) | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[unpipe](internal-8.ReadableStream.md#unpipe) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:217 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `string` \| `Uint8Array` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`void` + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[unshift](internal-8.ReadableStream.md#unshift) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:218 + +___ + +### wrap + +▸ **wrap**(`oldStream`): [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `oldStream` | [`ReadableStream`](internal-8.ReadableStream.md) | + +#### Returns + +[`ReadWriteStream`](internal-8.ReadWriteStream.md) + +#### Inherited from + +[ReadableStream](internal-8.ReadableStream.md).[wrap](internal-8.ReadableStream.md#wrap) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:219 + +___ + +### write + +▸ **write**(`buffer`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buffer` | `string` \| `Uint8Array` | +| `cb?` | (`err?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[write](internal-8.WritableStream.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:225 + +▸ **write**(`str`, `encoding?`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | (`err?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Inherited from + +[WritableStream](internal-8.WritableStream.md).[write](internal-8.WritableStream.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:226 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md new file mode 100644 index 0000000000..c88effdad8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamController.md @@ -0,0 +1,81 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableByteStreamController + +[internal](../modules/internal-8.md).ReadableByteStreamController + +## Properties + +### byobRequest + +• `Readonly` **byobRequest**: `undefined` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:161 + +___ + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:162 + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:163 + +___ + +### enqueue + +▸ **enqueue**(`chunk`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | [`ArrayBufferView`](internal-8.ArrayBufferView.md) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:164 + +___ + +### error + +▸ **error**(`error?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `error?` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:165 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md new file mode 100644 index 0000000000..0f11ac065e --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableByteStreamControllerCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableByteStreamControllerCallback + +[internal](../modules/internal-8.md).ReadableByteStreamControllerCallback + +## Callable + +### ReadableByteStreamControllerCallback + +▸ **ReadableByteStreamControllerCallback**(`controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableByteStreamController`](../modules/internal-8.md#readablebytestreamcontroller) | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md new file mode 100644 index 0000000000..f79857ad5d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream-1.md @@ -0,0 +1,156 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStream + +[internal](../modules/internal-8.md).ReadableStream + +This Streams API interface represents a readable stream of byte data. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### locked + +• `Readonly` **locked**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:136 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`R`\> + +#### Returns + +[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:143 + +___ + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:137 + +___ + +### getReader + +▸ **getReader**(): [`ReadableStreamDefaultReader`](../modules/internal-8.md#readablestreamdefaultreader)<`R`\> + +#### Returns + +[`ReadableStreamDefaultReader`](../modules/internal-8.md#readablestreamdefaultreader)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:138 + +___ + +### pipeThrough + +▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../modules/internal-8.md#readablestream)<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transform` | [`ReadableWritablePair`](internal-8.ReadableWritablePair.md)<`T`, `R`\> | +| `options?` | [`StreamPipeOptions`](internal-8.StreamPipeOptions.md) | + +#### Returns + +[`ReadableStream`](../modules/internal-8.md#readablestream)<`T`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:139 + +___ + +### pipeTo + +▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | [`WritableStream`](../modules/internal-8.md#writablestream)<`R`\> | +| `options?` | [`StreamPipeOptions`](internal-8.StreamPipeOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:140 + +___ + +### tee + +▸ **tee**(): [[`ReadableStream`](../modules/internal-8.md#readablestream)<`R`\>, [`ReadableStream`](../modules/internal-8.md#readablestream)<`R`\>] + +#### Returns + +[[`ReadableStream`](../modules/internal-8.md#readablestream)<`R`\>, [`ReadableStream`](../modules/internal-8.md#readablestream)<`R`\>] + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:141 + +___ + +### values + +▸ **values**(`options?`): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`R`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `options?` | `Object` | +| `options.preventCancel?` | `boolean` | + +#### Returns + +[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:142 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md new file mode 100644 index 0000000000..d587f24ecc --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStream.md @@ -0,0 +1,906 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStream + +[internal](../modules/internal-8.md).ReadableStream + +## Hierarchy + +- [`EventEmitter`](internal-8.EventEmitter-2.md) + + ↳ **`ReadableStream`** + + ↳↳ [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +## Implemented by + +- [`ReadableBase`](../classes/internal-8.ReadableBase.md) + +## Properties + +### readable + +• **readable**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:210 + +## Methods + +### [asyncIterator] + +▸ **[asyncIterator]**(): [`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\> + +#### Returns + +[`AsyncIterableIterator`](internal-8.AsyncIterableIterator.md)<`string` \| [`Buffer`](../modules/internal-8.md#buffer)\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:220 + +___ + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[addListener](internal-8.EventEmitter-2.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[emit](internal-8.EventEmitter-2.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[eventNames](internal-8.EventEmitter-2.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[getMaxListeners](internal-8.EventEmitter-2.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### isPaused + +▸ **isPaused**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:215 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[listenerCount](internal-8.EventEmitter-2.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[listeners](internal-8.EventEmitter-2.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[off](internal-8.EventEmitter-2.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[on](internal-8.EventEmitter-2.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[once](internal-8.EventEmitter-2.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### pause + +▸ **pause**(): [`ReadableStream`](internal-8.ReadableStream.md) + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:213 + +___ + +### pipe + +▸ **pipe**<`T`\>(`destination`, `options?`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`WritableStream`](internal-8.WritableStream.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination` | `T` | +| `options?` | `Object` | +| `options.end?` | `boolean` | + +#### Returns + +`T` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:216 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[prependListener](internal-8.EventEmitter-2.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[prependOnceListener](internal-8.EventEmitter-2.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[rawListeners](internal-8.EventEmitter-2.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### read + +▸ **read**(`size?`): `string` \| [`Buffer`](../modules/internal-8.md#buffer) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `size?` | `number` | + +#### Returns + +`string` \| [`Buffer`](../modules/internal-8.md#buffer) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:211 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`ReadableStream`](internal-8.ReadableStream.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[removeAllListeners](internal-8.EventEmitter-2.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`ReadableStream`](internal-8.ReadableStream.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[removeListener](internal-8.EventEmitter-2.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### resume + +▸ **resume**(): [`ReadableStream`](internal-8.ReadableStream.md) + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:214 + +___ + +### setEncoding + +▸ **setEncoding**(`encoding`): [`ReadableStream`](internal-8.ReadableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:212 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`ReadableStream`](internal-8.ReadableStream.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[setMaxListeners](internal-8.EventEmitter-2.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### unpipe + +▸ **unpipe**(`destination?`): [`ReadableStream`](internal-8.ReadableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `destination?` | [`WritableStream`](internal-8.WritableStream.md) | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:217 + +___ + +### unshift + +▸ **unshift**(`chunk`, `encoding?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `string` \| `Uint8Array` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:218 + +___ + +### wrap + +▸ **wrap**(`oldStream`): [`ReadableStream`](internal-8.ReadableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `oldStream` | [`ReadableStream`](internal-8.ReadableStream.md) | + +#### Returns + +[`ReadableStream`](internal-8.ReadableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:219 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md new file mode 100644 index 0000000000..072b6f2f9d --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultController.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultController + +[internal](../modules/internal-8.md).ReadableStreamDefaultController + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:172 + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:173 + +___ + +### enqueue + +▸ **enqueue**(`chunk?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk?` | `R` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:174 + +___ + +### error + +▸ **error**(`e?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:175 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md new file mode 100644 index 0000000000..9897303127 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultReadDoneResult + +[internal](../modules/internal-8.md).ReadableStreamDefaultReadDoneResult + +## Properties + +### done + +• **done**: ``true`` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:73 + +___ + +### value + +• `Optional` **value**: `undefined` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:74 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md new file mode 100644 index 0000000000..88778135e6 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReadValueResult.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultReadValueResult + +[internal](../modules/internal-8.md).ReadableStreamDefaultReadValueResult + +## Type parameters + +| Name | +| :------ | +| `T` | + +## Properties + +### done + +• **done**: ``false`` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:69 + +___ + +### value + +• **value**: `T` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md new file mode 100644 index 0000000000..7b6181d7b0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamDefaultReader.md @@ -0,0 +1,85 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamDefaultReader + +[internal](../modules/internal-8.md).ReadableStreamDefaultReader + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Hierarchy + +- [`ReadableStreamGenericReader`](internal-8.ReadableStreamGenericReader.md) + + ↳ **`ReadableStreamDefaultReader`** + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +#### Inherited from + +[ReadableStreamGenericReader](internal-8.ReadableStreamGenericReader.md).[closed](internal-8.ReadableStreamGenericReader.md#closed) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:65 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[ReadableStreamGenericReader](internal-8.ReadableStreamGenericReader.md).[cancel](internal-8.ReadableStreamGenericReader.md#cancel) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:66 + +___ + +### read + +▸ **read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../modules/internal-8.md#readablestreamdefaultreadresult)<`R`\>\> + +#### Returns + +`Promise`<[`ReadableStreamDefaultReadResult`](../modules/internal-8.md#readablestreamdefaultreadresult)<`R`\>\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:151 + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:152 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md new file mode 100644 index 0000000000..df053b8e6c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamErrorCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamErrorCallback + +[internal](../modules/internal-8.md).ReadableStreamErrorCallback + +## Callable + +### ReadableStreamErrorCallback + +▸ **ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason` | `any` | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:132 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md new file mode 100644 index 0000000000..250383d603 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableStreamGenericReader.md @@ -0,0 +1,43 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableStreamGenericReader + +[internal](../modules/internal-8.md).ReadableStreamGenericReader + +## Hierarchy + +- **`ReadableStreamGenericReader`** + + ↳ [`ReadableStreamDefaultReader`](internal-8.ReadableStreamDefaultReader.md) + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:65 + +## Methods + +### cancel + +▸ **cancel**(`reason?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:66 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md new file mode 100644 index 0000000000..7adf7c1f69 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.ReadableWritablePair.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableWritablePair + +[internal](../modules/internal-8.md).ReadableWritablePair + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | +| `W` | `any` | + +## Properties + +### readable + +• **readable**: [`ReadableStream`](../modules/internal-8.md#readablestream)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:5 + +___ + +### writable + +• **writable**: [`WritableStream`](../modules/internal-8.md#writablestream)<`W`\> + +Provides a convenient, chainable way of piping this readable stream +through a transform stream (or any other { writable, readable } +pair). It simply pipes the stream into the writable side of the +supplied pair, and returns the readable side for further use. + +Piping a stream will lock it for the duration of the pipe, preventing +any other consumer from acquiring a reader. + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md new file mode 100644 index 0000000000..f36c48fecf --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBuffer.md @@ -0,0 +1,62 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: SharedArrayBuffer + +[internal](../modules/internal-8.md).SharedArrayBuffer + +## Properties + +### [species] + +• `Readonly` **[species]**: [`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:32 + +___ + +### [toStringTag] + +• `Readonly` **[toStringTag]**: ``"SharedArrayBuffer"`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:33 + +___ + +### byteLength + +• `Readonly` **byteLength**: `number` + +Read-only. The length of the ArrayBuffer (in bytes). + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:26 + +## Methods + +### slice + +▸ **slice**(`begin`, `end?`): [`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer) + +Returns a section of an SharedArrayBuffer. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `begin` | `number` | +| `end?` | `number` | + +#### Returns + +[`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:31 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md new file mode 100644 index 0000000000..055a95aaca --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.SharedArrayBufferConstructor.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: SharedArrayBufferConstructor + +[internal](../modules/internal-8.md).SharedArrayBufferConstructor + +## Properties + +### prototype + +• `Readonly` **prototype**: [`SharedArrayBuffer`](../modules/internal-8.md#sharedarraybuffer) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:37 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md new file mode 100644 index 0000000000..4c7f45a8bf --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.StaticEventEmitterOptions.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: StaticEventEmitterOptions + +[internal](../modules/internal-8.md).StaticEventEmitterOptions + +## Properties + +### signal + +• `Optional` **signal**: `AbortSignal` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:92 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md new file mode 100644 index 0000000000..cf5f6aa60a --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.StreamPipeOptions.md @@ -0,0 +1,87 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: StreamPipeOptions + +[internal](../modules/internal-8.md).StreamPipeOptions + +## Properties + +### preventAbort + +• `Optional` **preventAbort**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:18 + +___ + +### preventCancel + +• `Optional` **preventCancel**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:19 + +___ + +### preventClose + +• `Optional` **preventClose**: `boolean` + +Pipes this readable stream to a given writable stream destination. +The way in which the piping process behaves under various error +conditions can be customized with a number of passed options. It +returns a promise that fulfills when the piping process completes +successfully, or rejects if any errors were encountered. + +Piping a stream will lock it for the duration of the pipe, preventing +any other consumer from acquiring a reader. + +Errors and closures of the source and destination streams propagate +as follows: + +An error in this source readable stream will abort destination, +unless preventAbort is truthy. The returned promise will be rejected +with the source's error, or with any error that occurs during +aborting the destination. + +An error in destination will cancel this source readable stream, +unless preventCancel is truthy. The returned promise will be rejected +with the destination's error, or with any error that occurs during +canceling the source. + +When this source readable stream closes, destination will be closed, +unless preventClose is truthy. The returned promise will be fulfilled +once this process completes, unless an error is encountered while +closing the destination, in which case it will be rejected with that +error. + +If destination starts out closed or closing, this source readable +stream will be canceled, unless preventCancel is true. The returned +promise will be rejected with an error indicating piping to a closed +stream failed, or with any error that occurs during canceling the +source. + +The signal option can be set to an AbortSignal to allow aborting an +ongoing pipe operation via the corresponding AbortController. In this +case, this source readable stream will be canceled, and destination +aborted, unless the respective options preventCancel or preventAbort +are set. + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:61 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:62 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md new file mode 100644 index 0000000000..b21ee5aa61 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.StringComparisonOperator.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: StringComparisonOperator + +[internal](../modules/internal-8.md).StringComparisonOperator + +## Properties + +### contains + +• `Optional` **contains**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:117 + +___ + +### ends\_with + +• `Optional` **ends\_with**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:119 + +___ + +### gt + +• `Optional` **gt**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:114 + +___ + +### gte + +• `Optional` **gte**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:115 + +___ + +### lt + +• `Optional` **lt**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:113 + +___ + +### lte + +• `Optional` **lte**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:116 + +___ + +### starts\_with + +• `Optional` **starts\_with**: `string` + +#### Defined in + +packages/types/dist/common/common.d.ts:118 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md new file mode 100644 index 0000000000..66d0f01471 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.TransformOptions.md @@ -0,0 +1,409 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: TransformOptions + +[internal](../modules/internal-8.md).TransformOptions + +## Hierarchy + +- [`DuplexOptions`](internal-8.DuplexOptions.md) + + ↳ **`TransformOptions`** + +## Properties + +### allowHalfOpen + +• `Optional` **allowHalfOpen**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[allowHalfOpen](internal-8.DuplexOptions.md#allowhalfopen) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:831 + +___ + +### autoDestroy + +• `Optional` **autoDestroy**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[autoDestroy](internal-8.DuplexOptions.md#autodestroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:776 + +___ + +### decodeStrings + +• `Optional` **decodeStrings**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[decodeStrings](internal-8.DuplexOptions.md#decodestrings) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:800 + +___ + +### defaultEncoding + +• `Optional` **defaultEncoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[defaultEncoding](internal-8.DuplexOptions.md#defaultencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:801 + +___ + +### emitClose + +• `Optional` **emitClose**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[emitClose](internal-8.DuplexOptions.md#emitclose) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:771 + +___ + +### encoding + +• `Optional` **encoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[encoding](internal-8.DuplexOptions.md#encoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:779 + +___ + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[highWaterMark](internal-8.DuplexOptions.md#highwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:772 + +___ + +### objectMode + +• `Optional` **objectMode**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[objectMode](internal-8.DuplexOptions.md#objectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:773 + +___ + +### readableHighWaterMark + +• `Optional` **readableHighWaterMark**: `number` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[readableHighWaterMark](internal-8.DuplexOptions.md#readablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:834 + +___ + +### readableObjectMode + +• `Optional` **readableObjectMode**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[readableObjectMode](internal-8.DuplexOptions.md#readableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:832 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[signal](internal-8.DuplexOptions.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +___ + +### writableCorked + +• `Optional` **writableCorked**: `number` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[writableCorked](internal-8.DuplexOptions.md#writablecorked) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:836 + +___ + +### writableHighWaterMark + +• `Optional` **writableHighWaterMark**: `number` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[writableHighWaterMark](internal-8.DuplexOptions.md#writablehighwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:835 + +___ + +### writableObjectMode + +• `Optional` **writableObjectMode**: `boolean` + +#### Inherited from + +[DuplexOptions](internal-8.DuplexOptions.md).[writableObjectMode](internal-8.DuplexOptions.md#writableobjectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:833 + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[construct](internal-8.DuplexOptions.md#construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1046 + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[destroy](internal-8.DuplexOptions.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1058 + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[final](internal-8.DuplexOptions.md#final) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1057 + +___ + +### flush + +▸ `Optional` **flush**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1060 + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `size` | `number` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[read](internal-8.DuplexOptions.md#read) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1047 + +___ + +### transform + +▸ `Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | [`TransformCallback`](../modules/internal-8.md#transformcallback) | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1059 + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[write](internal-8.DuplexOptions.md#write) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1048 + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Transform`](../classes/internal-8.Transform.md) | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Overrides + +[DuplexOptions](internal-8.DuplexOptions.md).[writev](internal-8.DuplexOptions.md#writev) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1049 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md new file mode 100644 index 0000000000..e08df0ee84 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingByteSource.md @@ -0,0 +1,57 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingByteSource + +[internal](../modules/internal-8.md).UnderlyingByteSource + +## Properties + +### autoAllocateChunkSize + +• `Optional` **autoAllocateChunkSize**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:112 + +___ + +### cancel + +• `Optional` **cancel**: [`ReadableStreamErrorCallback`](internal-8.ReadableStreamErrorCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:113 + +___ + +### pull + +• `Optional` **pull**: [`ReadableByteStreamControllerCallback`](internal-8.ReadableByteStreamControllerCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:114 + +___ + +### start + +• `Optional` **start**: [`ReadableByteStreamControllerCallback`](internal-8.ReadableByteStreamControllerCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:115 + +___ + +### type + +• **type**: ``"bytes"`` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:116 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md new file mode 100644 index 0000000000..02e43bf443 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSink.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSink + +[internal](../modules/internal-8.md).UnderlyingSink + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### abort + +• `Optional` **abort**: [`UnderlyingSinkAbortCallback`](internal-8.UnderlyingSinkAbortCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:125 + +___ + +### close + +• `Optional` **close**: [`UnderlyingSinkCloseCallback`](internal-8.UnderlyingSinkCloseCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:126 + +___ + +### start + +• `Optional` **start**: [`UnderlyingSinkStartCallback`](internal-8.UnderlyingSinkStartCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:127 + +___ + +### type + +• `Optional` **type**: `undefined` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:128 + +___ + +### write + +• `Optional` **write**: [`UnderlyingSinkWriteCallback`](internal-8.UnderlyingSinkWriteCallback.md)<`W`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:129 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md new file mode 100644 index 0000000000..473597335f --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkAbortCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkAbortCallback + +[internal](../modules/internal-8.md).UnderlyingSinkAbortCallback + +## Callable + +### UnderlyingSinkAbortCallback + +▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:82 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md new file mode 100644 index 0000000000..598d1a787c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkCloseCallback.md @@ -0,0 +1,21 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkCloseCallback + +[internal](../modules/internal-8.md).UnderlyingSinkCloseCallback + +## Callable + +### UnderlyingSinkCloseCallback + +▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:85 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md new file mode 100644 index 0000000000..11cb65c2eb --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkStartCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkStartCallback + +[internal](../modules/internal-8.md).UnderlyingSinkStartCallback + +## Callable + +### UnderlyingSinkStartCallback + +▸ **UnderlyingSinkStartCallback**(`controller`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`WritableStreamDefaultController`](../modules/internal-8.md#writablestreamdefaultcontroller) | + +#### Returns + +`any` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:88 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md new file mode 100644 index 0000000000..9b5a1a1847 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSinkWriteCallback.md @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSinkWriteCallback + +[internal](../modules/internal-8.md).UnderlyingSinkWriteCallback + +## Type parameters + +| Name | +| :------ | +| `W` | + +## Callable + +### UnderlyingSinkWriteCallback + +▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk` | `W` | +| `controller` | [`WritableStreamDefaultController`](../modules/internal-8.md#writablestreamdefaultcontroller) | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:91 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md new file mode 100644 index 0000000000..76df0e3be4 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSource.md @@ -0,0 +1,53 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSource + +[internal](../modules/internal-8.md).UnderlyingSource + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +## Properties + +### cancel + +• `Optional` **cancel**: [`UnderlyingSourceCancelCallback`](internal-8.UnderlyingSourceCancelCallback.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:119 + +___ + +### pull + +• `Optional` **pull**: [`UnderlyingSourcePullCallback`](internal-8.UnderlyingSourcePullCallback.md)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:120 + +___ + +### start + +• `Optional` **start**: [`UnderlyingSourceStartCallback`](internal-8.UnderlyingSourceStartCallback.md)<`R`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:121 + +___ + +### type + +• `Optional` **type**: `undefined` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:122 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md new file mode 100644 index 0000000000..39c2c51974 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceCancelCallback.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourceCancelCallback + +[internal](../modules/internal-8.md).UnderlyingSourceCancelCallback + +## Callable + +### UnderlyingSourceCancelCallback + +▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:94 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md new file mode 100644 index 0000000000..059ed8d2db --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourcePullCallback.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourcePullCallback + +[internal](../modules/internal-8.md).UnderlyingSourcePullCallback + +## Type parameters + +| Name | +| :------ | +| `R` | + +## Callable + +### UnderlyingSourcePullCallback + +▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamController`](../modules/internal-8.md#readablestreamcontroller)<`R`\> | + +#### Returns + +`void` \| [`PromiseLike`](internal-8.PromiseLike.md)<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:97 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md new file mode 100644 index 0000000000..a97ccd182e --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UnderlyingSourceStartCallback.md @@ -0,0 +1,33 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UnderlyingSourceStartCallback + +[internal](../modules/internal-8.md).UnderlyingSourceStartCallback + +## Type parameters + +| Name | +| :------ | +| `R` | + +## Callable + +### UnderlyingSourceStartCallback + +▸ **UnderlyingSourceStartCallback**(`controller`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `controller` | [`ReadableStreamController`](../modules/internal-8.md#readablestreamcontroller)<`R`\> | + +#### Returns + +`any` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:100 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md new file mode 100644 index 0000000000..2c7098f41a --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.UpdateUserInput.md @@ -0,0 +1,77 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: UpdateUserInput + +[internal](../modules/internal-8.md).UpdateUserInput + +## Properties + +### api\_token + +• `Optional` **api\_token**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:17 + +___ + +### email + +• `Optional` `Readonly` **email**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:13 + +___ + +### first\_name + +• `Optional` **first\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:14 + +___ + +### last\_name + +• `Optional` **last\_name**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:15 + +___ + +### metadata + +• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/types/user.d.ts:19 + +___ + +### password\_hash + +• `Optional` `Readonly` **password\_hash**: `string` + +#### Defined in + +packages/medusa/dist/types/user.d.ts:16 + +___ + +### role + +• `Optional` **role**: [`UserRoles`](../enums/internal-1.UserRoles.md) + +#### Defined in + +packages/medusa/dist/types/user.d.ts:18 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md new file mode 100644 index 0000000000..0da80f36a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream-1.md @@ -0,0 +1,75 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStream + +[internal](../modules/internal-8.md).WritableStream + +This Streams API interface provides a standard abstraction for writing +streaming data to a destination, known as a sink. This object comes with +built-in back pressure and queuing. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### locked + +• `Readonly` **locked**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:212 + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:213 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:214 + +___ + +### getWriter + +▸ **getWriter**(): [`WritableStreamDefaultWriter`](../modules/internal-8.md#writablestreamdefaultwriter)<`W`\> + +#### Returns + +[`WritableStreamDefaultWriter`](../modules/internal-8.md#writablestreamdefaultwriter)<`W`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:215 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md new file mode 100644 index 0000000000..c2ea4a913b --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStream.md @@ -0,0 +1,815 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStream + +[internal](../modules/internal-8.md).WritableStream + +## Hierarchy + +- [`EventEmitter`](internal-8.EventEmitter-2.md) + + ↳ **`WritableStream`** + + ↳↳ [`ReadWriteStream`](internal-8.ReadWriteStream.md) + +## Implemented by + +- [`WritableBase`](../classes/internal-8.WritableBase.md) + +## Properties + +### writable + +• **writable**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:224 + +## Methods + +### addListener + +▸ **addListener**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Alias for `emitter.on(eventName, listener)`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[addListener](internal-8.EventEmitter-2.md#addlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:390 + +___ + +### emit + +▸ **emit**(`eventName`, `...args`): `boolean` + +Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments +to each. + +Returns `true` if the event had listeners, `false` otherwise. + +```js +import { EventEmitter } from 'node:events'; +const myEmitter = new EventEmitter(); + +// First listener +myEmitter.on('event', function firstListener() { + console.log('Helloooo! first listener'); +}); +// Second listener +myEmitter.on('event', function secondListener(arg1, arg2) { + console.log(`event with parameters ${arg1}, ${arg2} in second listener`); +}); +// Third listener +myEmitter.on('event', function thirdListener(...args) { + const parameters = args.join(', '); + console.log(`event with parameters ${parameters} in third listener`); +}); + +console.log(myEmitter.listeners('event')); + +myEmitter.emit('event', 1, 2, 3, 4, 5); + +// Prints: +// [ +// [Function: firstListener], +// [Function: secondListener], +// [Function: thirdListener] +// ] +// Helloooo! first listener +// event with parameters 1, 2 in second listener +// event with parameters 1, 2, 3, 4, 5 in third listener +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `...args` | `any`[] | + +#### Returns + +`boolean` + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[emit](internal-8.EventEmitter-2.md#emit) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:652 + +___ + +### end + +▸ **end**(`cb?`): [`WritableStream`](internal-8.WritableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cb?` | () => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:227 + +▸ **end**(`data`, `cb?`): [`WritableStream`](internal-8.WritableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `string` \| `Uint8Array` | +| `cb?` | () => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:228 + +▸ **end**(`str`, `encoding?`, `cb?`): [`WritableStream`](internal-8.WritableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | () => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:229 + +___ + +### eventNames + +▸ **eventNames**(): (`string` \| `symbol`)[] + +Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or `Symbol`s. + +```js +import { EventEmitter } from 'node:events'; + +const myEE = new EventEmitter(); +myEE.on('foo', () => {}); +myEE.on('bar', () => {}); + +const sym = Symbol('symbol'); +myEE.on(sym, () => {}); + +console.log(myEE.eventNames()); +// Prints: [ 'foo', 'bar', Symbol(symbol) ] +``` + +#### Returns + +(`string` \| `symbol`)[] + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[eventNames](internal-8.EventEmitter-2.md#eventnames) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:715 + +___ + +### getMaxListeners + +▸ **getMaxListeners**(): `number` + +Returns the current max listener value for the `EventEmitter` which is either +set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. + +#### Returns + +`number` + +**`Since`** + +v1.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[getMaxListeners](internal-8.EventEmitter-2.md#getmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:567 + +___ + +### listenerCount + +▸ **listenerCount**(`eventName`, `listener?`): `number` + +Returns the number of listeners listening for the event named `eventName`. +If `listener` is provided, it will return how many times the listener is found +in the list of the listeners of the event. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event being listened for | +| `listener?` | `Function` | The event handler function | + +#### Returns + +`number` + +**`Since`** + +v3.2.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[listenerCount](internal-8.EventEmitter-2.md#listenercount) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:661 + +___ + +### listeners + +▸ **listeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +console.log(util.inspect(server.listeners('connection'))); +// Prints: [ [Function] ] +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[listeners](internal-8.EventEmitter-2.md#listeners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:580 + +___ + +### off + +▸ **off**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Alias for `emitter.removeListener()`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v10.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[off](internal-8.EventEmitter-2.md#off) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:540 + +___ + +### on + +▸ **on**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Adds the `listener` function to the end of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.on('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.on('foo', () => console.log('a')); +myEE.prependListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.1.101 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[on](internal-8.EventEmitter-2.md#on) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:422 + +___ + +### once + +▸ **once**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Adds a **one-time**`listener` function for the event named `eventName`. The +next time `eventName` is triggered, this listener is removed and then invoked. + +```js +server.once('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +By default, event listeners are invoked in the order they are added. The`emitter.prependOnceListener()` method can be used as an alternative to add the +event listener to the beginning of the listeners array. + +```js +import { EventEmitter } from 'node:events'; +const myEE = new EventEmitter(); +myEE.once('foo', () => console.log('a')); +myEE.prependOnceListener('foo', () => console.log('b')); +myEE.emit('foo'); +// Prints: +// b +// a +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.3.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[once](internal-8.EventEmitter-2.md#once) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:452 + +___ + +### prependListener + +▸ **prependListener**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Adds the `listener` function to the _beginning_ of the listeners array for the +event named `eventName`. No checks are made to see if the `listener` has +already been added. Multiple calls passing the same combination of `eventName`and `listener` will result in the `listener` being added, and called, multiple +times. + +```js +server.prependListener('connection', (stream) => { + console.log('someone connected!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[prependListener](internal-8.EventEmitter-2.md#prependlistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:679 + +___ + +### prependOnceListener + +▸ **prependOnceListener**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this +listener is removed, and then invoked. + +```js +server.prependOnceListener('connection', (stream) => { + console.log('Ah, we have our first user!'); +}); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `eventName` | `string` \| `symbol` | The name of the event. | +| `listener` | (...`args`: `any`[]) => `void` | The callback function | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v6.0.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[prependOnceListener](internal-8.EventEmitter-2.md#prependoncelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:695 + +___ + +### rawListeners + +▸ **rawListeners**(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | + +#### Returns + +`Function`[] + +**`Since`** + +v9.4.0 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[rawListeners](internal-8.EventEmitter-2.md#rawlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:611 + +___ + +### removeAllListeners + +▸ **removeAllListeners**(`event?`): [`WritableStream`](internal-8.WritableStream.md) + +Removes all listeners, or those of the specified `eventName`. + +It is bad practice to remove listeners added elsewhere in the code, +particularly when the `EventEmitter` instance was created by some other +component or module (e.g. sockets or file streams). + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event?` | `string` \| `symbol` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[removeAllListeners](internal-8.EventEmitter-2.md#removealllisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:551 + +___ + +### removeListener + +▸ **removeListener**(`eventName`, `listener`): [`WritableStream`](internal-8.WritableStream.md) + +Removes the specified `listener` from the listener array for the event named`eventName`. + +```js +const callback = (stream) => { + console.log('someone connected!'); +}; +server.on('connection', callback); +// ... +server.removeListener('connection', callback); +``` + +`removeListener()` will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified `eventName`, then `removeListener()` must be +called multiple times to remove each instance. + +Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that any`removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution +will not remove them from`emit()` in progress. Subsequent events behave as expected. + +```js +import { EventEmitter } from 'node:events'; +class MyEmitter extends EventEmitter {} +const myEmitter = new MyEmitter(); + +const callbackA = () => { + console.log('A'); + myEmitter.removeListener('event', callbackB); +}; + +const callbackB = () => { + console.log('B'); +}; + +myEmitter.on('event', callbackA); + +myEmitter.on('event', callbackB); + +// callbackA removes listener callbackB but it will still be called. +// Internal listener array at time of emit [callbackA, callbackB] +myEmitter.emit('event'); +// Prints: +// A +// B + +// callbackB is now removed. +// Internal listener array [callbackA] +myEmitter.emit('event'); +// Prints: +// A +``` + +Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered _after_ the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the `emitter.listeners()` method will need to be recreated. + +When a single function has been added as a handler multiple times for a single +event (as in the example below), `removeListener()` will remove the most +recently added instance. In the example the `once('ping')`listener is removed: + +```js +import { EventEmitter } from 'node:events'; +const ee = new EventEmitter(); + +function pong() { + console.log('pong'); +} + +ee.on('ping', pong); +ee.once('ping', pong); +ee.removeListener('ping', pong); + +ee.emit('ping'); +ee.emit('ping'); +``` + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.1.26 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[removeListener](internal-8.EventEmitter-2.md#removelistener) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:535 + +___ + +### setMaxListeners + +▸ **setMaxListeners**(`n`): [`WritableStream`](internal-8.WritableStream.md) + +By default `EventEmitter`s will print a warning if more than `10` listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The `emitter.setMaxListeners()` method allows the limit to be +modified for this specific `EventEmitter` instance. The value can be set to`Infinity` (or `0`) to indicate an unlimited number of listeners. + +Returns a reference to the `EventEmitter`, so that calls can be chained. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `n` | `number` | + +#### Returns + +[`WritableStream`](internal-8.WritableStream.md) + +**`Since`** + +v0.3.5 + +#### Inherited from + +[EventEmitter](internal-8.EventEmitter-2.md).[setMaxListeners](internal-8.EventEmitter-2.md#setmaxlisteners) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:561 + +___ + +### write + +▸ **write**(`buffer`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `buffer` | `string` \| `Uint8Array` | +| `cb?` | (`err?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:225 + +▸ **write**(`str`, `encoding?`, `cb?`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | +| `encoding?` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `cb?` | (`err?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:226 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md new file mode 100644 index 0000000000..52fa52e208 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultController.md @@ -0,0 +1,32 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStreamDefaultController + +[internal](../modules/internal-8.md).WritableStreamDefaultController + +This Streams API interface represents a controller allowing control of a +WritableStream's state. When constructing a WritableStream, the +underlying sink is given a corresponding WritableStreamDefaultController +instance to manipulate. + +## Methods + +### error + +▸ **error**(`e?`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `e?` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:247 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md new file mode 100644 index 0000000000..45ca32d617 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.WritableStreamDefaultWriter.md @@ -0,0 +1,116 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableStreamDefaultWriter + +[internal](../modules/internal-8.md).WritableStreamDefaultWriter + +This Streams API interface is the object returned by +WritableStream.getWriter() and once created locks the < writer to the +WritableStream ensuring that no other streams can write to the underlying +sink. + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +## Properties + +### closed + +• `Readonly` **closed**: `Promise`<`undefined`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:228 + +___ + +### desiredSize + +• `Readonly` **desiredSize**: ``null`` \| `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:229 + +___ + +### ready + +• `Readonly` **ready**: `Promise`<`undefined`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:230 + +## Methods + +### abort + +▸ **abort**(`reason?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `reason?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:231 + +___ + +### close + +▸ **close**(): `Promise`<`void`\> + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:232 + +___ + +### releaseLock + +▸ **releaseLock**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:233 + +___ + +### write + +▸ **write**(`chunk?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `chunk?` | `W` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:234 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md b/www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md new file mode 100644 index 0000000000..833deee022 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8._DOMEventTarget.md @@ -0,0 +1,30 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: \_DOMEventTarget + +[internal](../modules/internal-8.md)._DOMEventTarget + +## Methods + +### addEventListener + +▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` | +| `listener` | (...`args`: `any`[]) => `void` | +| `opts?` | `Object` | +| `opts.once` | `boolean` | + +#### Returns + +`any` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:83 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md b/www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md new file mode 100644 index 0000000000..cf2a0ea023 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8._NodeEventTarget.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: \_NodeEventTarget + +[internal](../modules/internal-8.md)._NodeEventTarget + +## Methods + +### once + +▸ **once**(`eventName`, `listener`): [`_NodeEventTarget`](internal-8._NodeEventTarget.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `eventName` | `string` \| `symbol` | +| `listener` | (...`args`: `any`[]) => `void` | + +#### Returns + +[`_NodeEventTarget`](internal-8._NodeEventTarget.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md new file mode 100644 index 0000000000..1acc56684b --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.FinishedOptions.md @@ -0,0 +1,59 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FinishedOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).FinishedOptions + +## Hierarchy + +- [`Abortable`](internal-8.EventEmitter.Abortable.md) + + ↳ **`FinishedOptions`** + +## Properties + +### error + +• `Optional` **error**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1178 + +___ + +### readable + +• `Optional` **readable**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1179 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[Abortable](internal-8.EventEmitter.Abortable.md).[signal](internal-8.EventEmitter.Abortable.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +___ + +### writable + +• `Optional` **writable**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1180 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md new file mode 100644 index 0000000000..9444cb0ea0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.Pipe.md @@ -0,0 +1,63 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: Pipe + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).Pipe + +## Methods + +### close + +▸ **close**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1396 + +___ + +### hasRef + +▸ **hasRef**(): `boolean` + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1397 + +___ + +### ref + +▸ **ref**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1398 + +___ + +### unref + +▸ **unref**(): `void` + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1399 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md new file mode 100644 index 0000000000..5cb75ff1e3 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.PipelineOptions.md @@ -0,0 +1,27 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PipelineOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).PipelineOptions + +## Properties + +### end + +• `Optional` **end**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1249 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1248 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md new file mode 100644 index 0000000000..768a16d0db --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.ReadableOptions.md @@ -0,0 +1,169 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ReadableOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).ReadableOptions + +## Hierarchy + +- [`StreamOptions`](internal-8.internal-2.StreamOptions.md)<[`Readable`](../classes/internal-8.Readable.md)\> + + ↳ **`ReadableOptions`** + + ↳↳ [`DuplexOptions`](internal-8.DuplexOptions.md) + +## Properties + +### autoDestroy + +• `Optional` **autoDestroy**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[autoDestroy](internal-8.internal-2.StreamOptions.md#autodestroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:776 + +___ + +### emitClose + +• `Optional` **emitClose**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[emitClose](internal-8.internal-2.StreamOptions.md#emitclose) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:771 + +___ + +### encoding + +• `Optional` **encoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:779 + +___ + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[highWaterMark](internal-8.internal-2.StreamOptions.md#highwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:772 + +___ + +### objectMode + +• `Optional` **objectMode**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[objectMode](internal-8.internal-2.StreamOptions.md#objectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:773 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[signal](internal-8.internal-2.StreamOptions.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Readable`](../classes/internal-8.Readable.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[construct](internal-8.internal-2.StreamOptions.md#construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:774 + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Readable`](../classes/internal-8.Readable.md) | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[destroy](internal-8.internal-2.StreamOptions.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:775 + +___ + +### read + +▸ `Optional` **read**(`this`, `size`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Readable`](../classes/internal-8.Readable.md) | +| `size` | `number` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:780 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md new file mode 100644 index 0000000000..68b1d44283 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.StreamOptions.md @@ -0,0 +1,122 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: StreamOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).StreamOptions + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Stream`](../classes/internal-8.Stream.md) | + +## Hierarchy + +- [`Abortable`](internal-8.EventEmitter.Abortable.md) + + ↳ **`StreamOptions`** + + ↳↳ [`ReadableOptions`](internal-8.internal-2.ReadableOptions.md) + + ↳↳ [`WritableOptions`](internal-8.internal-2.WritableOptions.md) + +## Properties + +### autoDestroy + +• `Optional` **autoDestroy**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:776 + +___ + +### emitClose + +• `Optional` **emitClose**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:771 + +___ + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:772 + +___ + +### objectMode + +• `Optional` **objectMode**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:773 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[Abortable](internal-8.EventEmitter.Abortable.md).[signal](internal-8.EventEmitter.Abortable.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | `T` | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:774 + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | `T` | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:775 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md new file mode 100644 index 0000000000..d416807693 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal-2.WritableOptions.md @@ -0,0 +1,224 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: WritableOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal-2.md).WritableOptions + +## Hierarchy + +- [`StreamOptions`](internal-8.internal-2.StreamOptions.md)<[`Writable`](../classes/internal-8.internal-2.Writable.md)\> + + ↳ **`WritableOptions`** + + ↳↳ [`DuplexOptions`](internal-8.DuplexOptions.md) + +## Properties + +### autoDestroy + +• `Optional` **autoDestroy**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[autoDestroy](internal-8.internal-2.StreamOptions.md#autodestroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:776 + +___ + +### decodeStrings + +• `Optional` **decodeStrings**: `boolean` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:800 + +___ + +### defaultEncoding + +• `Optional` **defaultEncoding**: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:801 + +___ + +### emitClose + +• `Optional` **emitClose**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[emitClose](internal-8.internal-2.StreamOptions.md#emitclose) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:771 + +___ + +### highWaterMark + +• `Optional` **highWaterMark**: `number` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[highWaterMark](internal-8.internal-2.StreamOptions.md#highwatermark) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:772 + +___ + +### objectMode + +• `Optional` **objectMode**: `boolean` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[objectMode](internal-8.internal-2.StreamOptions.md#objectmode) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:773 + +___ + +### signal + +• `Optional` **signal**: `AbortSignal` + +When provided the corresponding `AbortController` can be used to cancel an asynchronous action. + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[signal](internal-8.internal-2.StreamOptions.md#signal) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/events.d.ts:380 + +## Methods + +### construct + +▸ `Optional` **construct**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Writable`](../classes/internal-8.internal-2.Writable.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[construct](internal-8.internal-2.StreamOptions.md#construct) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:774 + +___ + +### destroy + +▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Writable`](../classes/internal-8.internal-2.Writable.md) | +| `error` | ``null`` \| [`Error`](../modules/internal-8.md#error) | +| `callback` | (`error`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Inherited from + +[StreamOptions](internal-8.internal-2.StreamOptions.md).[destroy](internal-8.internal-2.StreamOptions.md#destroy) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:775 + +___ + +### final + +▸ `Optional` **final**(`this`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Writable`](../classes/internal-8.internal-2.Writable.md) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:811 + +___ + +### write + +▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Writable`](../classes/internal-8.internal-2.Writable.md) | +| `chunk` | `any` | +| `encoding` | [`BufferEncoding`](../modules/internal-8.md#bufferencoding) | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:802 + +___ + +### writev + +▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | [`Writable`](../classes/internal-8.internal-2.Writable.md) | +| `chunks` | { `chunk`: `any` ; `encoding`: [`BufferEncoding`](../modules/internal-8.md#bufferencoding) }[] | +| `callback` | (`error?`: ``null`` \| [`Error`](../modules/internal-8.md#error)) => `void` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:803 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md new file mode 100644 index 0000000000..f370c9ff8c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.CustomFindOptions.md @@ -0,0 +1,64 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: CustomFindOptions + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).CustomFindOptions + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `TModel` | `TModel` | +| `InKeys` | extends keyof `TModel` | + +## Properties + +### order + +• `Optional` **order**: `OrderByCondition` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:51 + +___ + +### select + +• `Optional` **select**: `FindOptionsSelect`<`TModel`\> \| `FindOptionsSelectByString`<`TModel`\> + +#### Defined in + +packages/medusa/dist/types/common.d.ts:47 + +___ + +### skip + +• `Optional` **skip**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:52 + +___ + +### take + +• `Optional` **take**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:53 + +___ + +### where + +• `Optional` **where**: `FindOptionsWhere`<`TModel`\> & { [P in string \| number \| symbol]?: TModel[P][] } \| `FindOptionsWhere`<`TModel`\>[] & { [P in string \| number \| symbol]?: TModel[P][] } + +#### Defined in + +packages/medusa/dist/types/common.d.ts:48 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md new file mode 100644 index 0000000000..1d09581810 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FindConfig.md @@ -0,0 +1,67 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FindConfig + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FindConfig + +## Type parameters + +| Name | +| :------ | +| `Entity` | + +## Properties + +### order + +• `Optional` **order**: `Object` + +#### Index signature + +▪ [K: `string`]: ``"ASC"`` \| ``"DESC"`` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:24 + +___ + +### relations + +• `Optional` **relations**: `string`[] + +#### Defined in + +packages/medusa/dist/types/common.d.ts:23 + +___ + +### select + +• `Optional` **select**: keyof `Entity`[] + +#### Defined in + +packages/medusa/dist/types/common.d.ts:20 + +___ + +### skip + +• `Optional` **skip**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:21 + +___ + +### take + +• `Optional` **take**: `number` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:22 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md new file mode 100644 index 0000000000..34c5fcc5cb --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.FulfillmentService.md @@ -0,0 +1,310 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: FulfillmentService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).FulfillmentService + +Fulfillment Provider interface +Fullfillment provider plugin services should extend the AbstractFulfillmentService from this file + +## Implemented by + +- [`AbstractFulfillmentService`](../classes/internal-8.internal.AbstractFulfillmentService.md) + +## Methods + +### calculatePrice + +▸ **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> + +Used to calculate a price for a given shipping option. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `optionData` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | +| `cart` | [`Cart`](../classes/internal-3.Cart.md) | + +#### Returns + +`Promise`<`number`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:47 + +___ + +### canCalculate + +▸ **canCalculate**(`data`): `Promise`<`boolean`\> + +Used to determine if a shipping option can have a calculated price + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:43 + +___ + +### cancelFulfillment + +▸ **cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\> + +Cancel a fulfillment using data from the fulfillment + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillmentData` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:56 + +___ + +### createFulfillment + +▸ **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata)\> + +Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order. +The returned value of this method will populate the `fulfillment.data` field. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingMethodData`](../modules/internal-8.md#shippingmethoddata) | +| `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | +| `order` | [`Order`](../classes/internal-3.Order.md) | +| `fulfillment` | [`Fulfillment`](../classes/internal-3.Fulfillment.md) | + +#### Returns + +`Promise`<[`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata)\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:52 + +___ + +### createReturn + +▸ **createReturn**(`returnOrder`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +Used to create a return order. Should return the data necessary for future +operations on the return; in particular the data may be used to receive +documents attached to the return. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `returnOrder` | [`CreateReturnType`](../modules/internal-8.md#createreturntype) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:62 + +___ + +### getFulfillmentDocuments + +▸ **getFulfillmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents associated with a fulfillment. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:66 + +___ + +### getFulfillmentOptions + +▸ **getFulfillmentOptions**(): `Promise`<`any`[]\> + +Called before a shipping option is created in Admin. The method should +return all of the options that the fulfillment provider can be used with, +and it is here the distinction between different shipping options are +enforced. For example, a fulfillment provider may offer Standard Shipping +and Express Shipping as fulfillment options, it is up to the store operator +to create shipping options in Medusa that are offered to the customer. + +#### Returns + +`Promise`<`any`[]\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:24 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the fulfillment plugin provider + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:15 + +___ + +### getReturnDocuments + +▸ **getReturnDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a return order. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:70 + +___ + +### getShipmentDocuments + +▸ **getShipmentDocuments**(`data`): `Promise`<`any`\> + +Used to retrieve documents related to a shipment. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:74 + +___ + +### retrieveDocuments + +▸ **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillmentData` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | +| `documentType` | ``"label"`` \| ``"invoice"`` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:75 + +___ + +### validateFulfillmentData + +▸ **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +Called before a shipping method is set on a cart to ensure that the data +sent with the shipping method is valid. The data object may contain extra +data about the shipment such as an id of a drop point. It is up to the +fulfillment provider to enforce that the correct data is being sent +through. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `optionData` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | +| `data` | [`FulfillmentProviderData`](../modules/internal-8.md#fulfillmentproviderdata) | +| `cart` | [`Cart`](../classes/internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\>\> + +the data to populate `cart.shipping_methods.$.data` this + is usually important for future actions like generating shipping labels + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:34 + +___ + +### validateOption + +▸ **validateOption**(`data`): `Promise`<`boolean`\> + +Called before a shipping option is created in Admin. Use this to ensure +that a fulfillment option does in fact exist. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`ShippingOptionData`](../modules/internal-8.md#shippingoptiondata) | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:39 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md new file mode 100644 index 0000000000..4a3bbcdb45 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IBatchJobStrategy.md @@ -0,0 +1,275 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IBatchJobStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IBatchJobStrategy + +## Hierarchy + +- [`TransactionBaseService`](../classes/internal-8.internal.TransactionBaseService.md) + + ↳ **`IBatchJobStrategy`** + +## Implemented by + +- [`AbstractBatchJobStrategy`](../classes/internal-8.internal.AbstractBatchJobStrategy.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__configModule__](../classes/internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__container__](../classes/internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](../classes/internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[manager_](../classes/internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[transactionManager_](../classes/internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[atomicPhase_](../classes/internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### buildTemplate + +▸ **buildTemplate**(): `Promise`<`string`\> + +Builds and returns a template file that can be downloaded and filled in + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:21 + +___ + +### preProcessBatchJob + +▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> + +Method for pre-processing a batch job + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:13 + +___ + +### prepareBatchJobForProcessing + +▸ **prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +Method for preparing a batch job for processing + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobEntity` | [`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput) | +| `req` | `Request` | + +#### Returns + +`Promise`<[`CreateBatchJobInput`](../modules/internal-8.internal.md#createbatchjobinput)\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:9 + +___ + +### processJob + +▸ **processJob**(`batchJobId`): `Promise`<`void`\> + +Method does the actual processing of the job. Should report back on the progress of the operation. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `batchJobId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:17 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](../classes/internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](internal-8.internal.IBatchJobStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`IBatchJobStrategy`](internal-8.internal.IBatchJobStrategy.md) + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[withTransaction](../classes/internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md new file mode 100644 index 0000000000..8d9a462080 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ICartCompletionStrategy.md @@ -0,0 +1,38 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ICartCompletionStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ICartCompletionStrategy + +## Implemented by + +- [`AbstractCartCompletionStrategy`](../classes/internal-8.internal.AbstractCartCompletionStrategy.md) + +## Methods + +### complete + +▸ **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/internal-8.internal.md#cartcompletionresponse)\> + +Takes a cart id and completes the cart. This for example takes place when +creating an order or confirming a swap. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `cartId` | `string` | the id of the Cart to complete. | +| `idempotencyKey` | [`IdempotencyKey`](../classes/internal-8.internal.IdempotencyKey.md) | the idempotency key for the request | +| `context` | [`RequestContext`](../modules/internal-8.md#requestcontext) | the request context for the completion request | + +#### Returns + +`Promise`<[`CartCompletionResponse`](../modules/internal-8.internal.md#cartcompletionresponse)\> + +the response for the completion request + +#### Defined in + +packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:19 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md new file mode 100644 index 0000000000..f0b468631c --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IFileService.md @@ -0,0 +1,328 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IFileService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IFileService + +## Hierarchy + +- [`TransactionBaseService`](../classes/internal-8.internal.TransactionBaseService.md) + + ↳ **`IFileService`** + +## Implemented by + +- [`AbstractFileService`](../classes/internal-8.internal.AbstractFileService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__configModule__](../classes/internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__container__](../classes/internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](../classes/internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[manager_](../classes/internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[transactionManager_](../classes/internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[atomicPhase_](../classes/internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### delete + +▸ **delete**(`fileData`): `Promise`<`void`\> + +remove file from fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`DeleteFileType`](../modules/internal-8.md#deletefiletype) | Remove file described by record | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:20 + +___ + +### getDownloadStream + +▸ **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](internal-8.ReadableStream.md)\> + +download file from fileservice as stream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`GetUploadedFileType`](../modules/internal-8.md#getuploadedfiletype) | file metadata relevant for fileservice to download the file | + +#### Returns + +`Promise`<[`ReadableStream`](internal-8.ReadableStream.md)\> + +readable stream of the file to download + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:32 + +___ + +### getPresignedDownloadUrl + +▸ **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> + +Generate a presigned download url to obtain a file + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`GetUploadedFileType`](../modules/internal-8.md#getuploadedfiletype) | file metadata relevant for fileservice to download the file | + +#### Returns + +`Promise`<`string`\> + +presigned url to download the file + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:38 + +___ + +### getUploadStreamDescriptor + +▸ **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../modules/internal-8.md#fileservicegetuploadstreamresult)\> + +upload file to fileservice from stream + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `fileData` | [`UploadStreamDescriptorType`](../modules/internal-8.md#uploadstreamdescriptortype) | file metadata relevant for fileservice to create and upload the file | + +#### Returns + +`Promise`<[`FileServiceGetUploadStreamResult`](../modules/internal-8.md#fileservicegetuploadstreamresult)\> + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:26 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](../classes/internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### upload + +▸ **upload**(`file`): `Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +upload file to fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `file` | `File` | Multer file from express multipart/form-data | + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:10 + +___ + +### uploadProtected + +▸ **uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +upload private file to fileservice + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `file` | `File` | Multer file from express multipart/form-data | + +#### Returns + +`Promise`<[`FileServiceUploadResult`](../modules/internal-8.md#fileserviceuploadresult)\> + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:15 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IFileService`](internal-8.internal.IFileService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`IFileService`](internal-8.internal.IFileService.md) + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[withTransaction](../classes/internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md new file mode 100644 index 0000000000..86641cd7a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.INotificationService.md @@ -0,0 +1,236 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: INotificationService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).INotificationService + +## Hierarchy + +- [`TransactionBaseService`](../classes/internal-8.internal.TransactionBaseService.md) + + ↳ **`INotificationService`** + +## Implemented by + +- [`AbstractNotificationService`](../classes/internal-8.internal.AbstractNotificationService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__configModule__](../classes/internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__container__](../classes/internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](../classes/internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[manager_](../classes/internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[transactionManager_](../classes/internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[atomicPhase_](../classes/internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### resendNotification + +▸ **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `notification` | `unknown` | +| `config` | `unknown` | +| `attachmentGenerator` | `unknown` | + +#### Returns + +`Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:9 + +___ + +### sendNotification + +▸ **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `event` | `string` | +| `data` | `unknown` | +| `attachmentGenerator` | `unknown` | + +#### Returns + +`Promise`<[`ReturnedData`](../modules/internal-8.md#returneddata)\> + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:8 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](../classes/internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`INotificationService`](internal-8.internal.INotificationService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`INotificationService`](internal-8.internal.INotificationService.md) + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[withTransaction](../classes/internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md new file mode 100644 index 0000000000..d19d09d5f9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.IPriceSelectionStrategy.md @@ -0,0 +1,90 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: IPriceSelectionStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).IPriceSelectionStrategy + +## Hierarchy + +- [`ITransactionBaseService`](internal-8.ITransactionBaseService.md) + + ↳ **`IPriceSelectionStrategy`** + +## Implemented by + +- [`AbstractPriceSelectionStrategy`](../classes/internal-8.internal.AbstractPriceSelectionStrategy.md) + +## Methods + +### calculateVariantPrice + +▸ **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/internal-8.internal.md#priceselectionresult)\>\> + +Calculate the original and discount price for a given variant in a set of +circumstances described in the context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | { `quantity?`: `number` ; `variantId`: `string` }[] | - | +| `context` | [`PriceSelectionContext`](../modules/internal-8.internal.md#priceselectioncontext) | Details relevant to determine the correct pricing of the variant | + +#### Returns + +`Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/internal-8.internal.md#priceselectionresult)\>\> + +pricing details in an object containing the calculated lowest price, +the default price an all valid prices for the given variant + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:15 + +___ + +### onVariantsPricesUpdate + +▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> + +Notify price selection strategy that variants prices have been updated. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `variantIds` | `string`[] | The ids of the updated variants | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:23 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](internal-8.internal.IPriceSelectionStrategy.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`IPriceSelectionStrategy`](internal-8.internal.IPriceSelectionStrategy.md) + +#### Inherited from + +[ITransactionBaseService](internal-8.ITransactionBaseService.md).[withTransaction](internal-8.ITransactionBaseService.md#withtransaction) + +#### Defined in + +packages/types/dist/transaction-base/transaction-base.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md new file mode 100644 index 0000000000..0dbb00b900 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxCalculationStrategy.md @@ -0,0 +1,34 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ITaxCalculationStrategy + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ITaxCalculationStrategy + +## Methods + +### calculate + +▸ **calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\> + +Calculates the tax amount for a given set of line items under applicable +tax conditions and calculation contexts. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | the line items to calculate the tax total for | +| `taxLines` | ([`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md) \| [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md))[] | the tax lines that applies to the calculation | +| `calculationContext` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | other details relevant for the calculation | + +#### Returns + +`Promise`<`number`\> + +the tax total + +#### Defined in + +packages/medusa/dist/interfaces/tax-calculation-strategy.d.ts:14 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md new file mode 100644 index 0000000000..90a09c90c8 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.ITaxService.md @@ -0,0 +1,42 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: ITaxService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).ITaxService + +Interface to be implemented by tax provider plugins. The interface defines a +single method `getTaxLines` that returns numerical rates to apply to line +items and shipping methods. + +## Implemented by + +- [`AbstractTaxService`](../classes/internal-8.internal.AbstractTaxService.md) + +## Methods + +### getTaxLines + +▸ **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../modules/internal-8.md#providertaxline)[]\> + +Retrieves the numerical tax lines for a calculation context. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `itemLines` | [`ItemTaxCalculationLine`](../modules/internal-8.internal.md#itemtaxcalculationline)[] | the line item calculation lines | +| `shippingLines` | [`ShippingTaxCalculationLine`](../modules/internal-8.internal.md#shippingtaxcalculationline)[] | - | +| `context` | [`TaxCalculationContext`](../modules/internal-8.internal.md#taxcalculationcontext) | other details relevant to the tax determination | + +#### Returns + +`Promise`<[`ProviderTaxLine`](../modules/internal-8.md#providertaxline)[]\> + +numerical tax rates that should apply to the provided calculation + lines + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:51 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md new file mode 100644 index 0000000000..c3c6613180 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessor.md @@ -0,0 +1,253 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PaymentProcessor + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentProcessor + +The new payment service plugin interface +This work is still experimental and can be changed until it becomes stable + +## Implemented by + +- [`AbstractPaymentProcessor`](../classes/internal-8.internal.AbstractPaymentProcessor.md) + +## Methods + +### authorizePayment + +▸ **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| { `data`: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +Authorize an existing session if it is not already authorized + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `context` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| { `data`: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:53 + +___ + +### cancelPayment + +▸ **cancelPayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Cancel an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:73 + +___ + +### capturePayment + +▸ **capturePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Capture an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:61 + +___ + +### deletePayment + +▸ **deletePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Delete an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:65 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +Return a unique identifier to retrieve the payment plugin provider + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:32 + +___ + +### getPaymentStatus + +▸ **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +Return the status of the session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:77 + +___ + +### initiatePayment + +▸ **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +Initiate a payment session with the external provider + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`PaymentProcessorContext`](../modules/internal-8.internal.md#paymentprocessorcontext) | + +#### Returns + +`Promise`<[`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:36 + +___ + +### refundPayment + +▸ **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Refund an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | +| `refundAmount` | `number` | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:47 + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentSessionData`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Retrieve an existing session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:69 + +___ + +### updatePayment + +▸ **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +Update an existing payment session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `context` | [`PaymentProcessorContext`](../modules/internal-8.internal.md#paymentprocessorcontext) | + +#### Returns + +`Promise`<`void` \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md) \| [`PaymentProcessorSessionResponse`](../modules/internal-8.internal.md#paymentprocessorsessionresponse)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:41 + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`sessionId`, `data`): `Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +Update the session data for a payment session + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `sessionId` | `string` | +| `data` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> | + +#### Returns + +`Promise`<[`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| [`PaymentProcessorError`](internal-8.internal.PaymentProcessorError.md)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:81 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md new file mode 100644 index 0000000000..a808c4dff9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentProcessorError.md @@ -0,0 +1,37 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PaymentProcessorError + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentProcessorError + +## Properties + +### code + +• `Optional` **code**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:21 + +___ + +### detail + +• `Optional` **detail**: `any` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:22 + +___ + +### error + +• **error**: `string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:20 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md new file mode 100644 index 0000000000..eaaf2a48e5 --- /dev/null +++ b/www/apps/docs/content/references/js-client/interfaces/internal-8.internal.PaymentService.md @@ -0,0 +1,567 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Interface: PaymentService + +[internal](../modules/internal-8.md).[internal](../modules/internal-8.internal.md).PaymentService + +This will be + +**`Deprecated`** + +in the near future use the new PaymentProcessor interface instead + +## Hierarchy + +- [`TransactionBaseService`](../classes/internal-8.internal.TransactionBaseService.md) + + ↳ **`PaymentService`** + +## Implemented by + +- [`AbstractPaymentService`](../classes/internal-8.internal.AbstractPaymentService.md) + +## Properties + +### \_\_configModule\_\_ + +• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__configModule__](../classes/internal-8.internal.TransactionBaseService.md#__configmodule__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:5 + +___ + +### \_\_container\_\_ + +• `Protected` `Readonly` **\_\_container\_\_**: `any` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__container__](../classes/internal-8.internal.TransactionBaseService.md#__container__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:4 + +___ + +### \_\_moduleDeclaration\_\_ + +• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\> + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[__moduleDeclaration__](../classes/internal-8.internal.TransactionBaseService.md#__moduledeclaration__) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:6 + +___ + +### manager\_ + +• `Protected` **manager\_**: `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[manager_](../classes/internal-8.internal.TransactionBaseService.md#manager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:7 + +___ + +### transactionManager\_ + +• `Protected` **transactionManager\_**: `undefined` \| `EntityManager` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[transactionManager_](../classes/internal-8.internal.TransactionBaseService.md#transactionmanager_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:8 + +## Accessors + +### activeManager\_ + +• `Protected` `get` **activeManager_**(): `EntityManager` + +#### Returns + +`EntityManager` + +#### Inherited from + +TransactionBaseService.activeManager\_ + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:9 + +## Methods + +### atomicPhase\_ + +▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type parameters + +| Name | +| :------ | +| `TResult` | +| `TError` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done | +| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. | +| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler | + +#### Returns + +`Promise`<`TResult`\> + +the result of the transactional work + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[atomicPhase_](../classes/internal-8.internal.TransactionBaseService.md#atomicphase_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:24 + +___ + +### authorizePayment + +▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/internal-8.internal.md#data) ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | +| `context` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<{ `data`: [`Data`](../modules/internal-8.internal.md#data) ; `status`: [`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md) }\> + +**`Deprecated`** + +in the near future use PaymentProcessor.authorizePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:71 + +___ + +### cancelPayment + +▸ **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](../classes/internal-3.Payment.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.cancelPayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:90 + +___ + +### capturePayment + +▸ **capturePayment**(`payment`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](../classes/internal-3.Payment.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.capturePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:79 + +___ + +### createPayment + +▸ **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +This will be + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `context` | [`Cart`](../classes/internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) | The type of this argument is meant to be temporary and once the previous method signature will be removed, the type will only be PaymentContext instead of Cart & PaymentContext | + +#### Returns + +`Promise`<[`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.initiatePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:48 + +▸ **createPayment**(`cart`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cart` | [`Cart`](../classes/internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use createPayment(context: `Cart & PaymentContext): Promise` instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:53 + +___ + +### deletePayment + +▸ **deletePayment**(`paymentSession`): `Promise`<`void`\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | + +#### Returns + +`Promise`<`void`\> + +**`Deprecated`** + +in the near future use PaymentProcessor.cancelPayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:95 + +___ + +### getIdentifier + +▸ **getIdentifier**(): `string` + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:31 + +___ + +### getPaymentData + +▸ **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSession` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.retrievePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:36 + +___ + +### getStatus + +▸ **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`PaymentSessionStatus`](../enums/internal-8.internal.PaymentSessionStatus.md)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.getPaymentStatus instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:105 + +___ + +### refundPayment + +▸ **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](../classes/internal-3.Payment.md) | +| `refundAmount` | `number` | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.refundPayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:85 + +___ + +### retrievePayment + +▸ **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentData` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.retrievePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:58 + +___ + +### retrieveSavedMethods + +▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)[]\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](../classes/internal-3.Customer.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)[]\> + +**`Deprecated`** + +in the near future use PaymentProcessor.getSavedMethods instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:100 + +___ + +### shouldRetryTransaction\_ + +▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`Record`](../modules/internal.md#record)<`string`, `unknown`\> \| { `code`: `string` } | + +#### Returns + +`boolean` + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[shouldRetryTransaction_](../classes/internal-8.internal.TransactionBaseService.md#shouldretrytransaction_) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:12 + +___ + +### updatePayment + +▸ **updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/internal-8.internal.md#data) \| [`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | +| `context` | [`Cart`](../classes/internal-3.Cart.md) & [`PaymentContext`](../modules/internal-8.internal.md#paymentcontext) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data) \| [`PaymentSessionResponse`](../modules/internal-8.internal.md#paymentsessionresponse)\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:59 + +▸ **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | +| `cart` | [`Cart`](../classes/internal-3.Cart.md) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.updatePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:65 + +___ + +### updatePaymentData + +▸ **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +This will be + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `paymentSessionData` | [`Data`](../modules/internal-8.internal.md#data) | +| `data` | [`Data`](../modules/internal-8.internal.md#data) | + +#### Returns + +`Promise`<[`Data`](../modules/internal-8.internal.md#data)\> + +**`Deprecated`** + +in the near future use PaymentProcessor.updatePayment instead + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:42 + +___ + +### withTransaction + +▸ **withTransaction**(`transactionManager?`): [`PaymentService`](internal-8.internal.PaymentService.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `transactionManager?` | `EntityManager` | + +#### Returns + +[`PaymentService`](internal-8.internal.PaymentService.md) + +#### Inherited from + +[TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md).[withTransaction](../classes/internal-8.internal.TransactionBaseService.md#withtransaction) + +#### Defined in + +packages/medusa/dist/interfaces/transaction-base-service.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md b/www/apps/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md deleted file mode 100644 index c90b73fc6c..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosAdapter.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosAdapter - -[internal](../modules/internal.md).AxiosAdapter - -## Callable - -### AxiosAdapter - -▸ **AxiosAdapter**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:18 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosError.md b/www/apps/docs/content/references/js-client/interfaces/internal.AxiosError.md deleted file mode 100644 index 9b84115527..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosError.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosError - -[internal](../modules/internal.md).AxiosError - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `D` | `any` | - -## Hierarchy - -- `Error` - - ↳ **`AxiosError`** - -## Properties - -### code - -• `Optional` **code**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:126 - -___ - -### config - -• **config**: [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:125 - -___ - -### isAxiosError - -• **isAxiosError**: `boolean` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:129 - -___ - -### request - -• `Optional` **request**: `any` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:127 - -___ - -### response - -• `Optional` **response**: [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `D`\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:128 - -___ - -### toJSON - -• **toJSON**: () => `object` - -#### Type declaration - -▸ (): `object` - -##### Returns - -`object` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:130 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosInstance.md b/www/apps/docs/content/references/js-client/interfaces/internal.AxiosInstance.md deleted file mode 100644 index 54eefcb704..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosInstance.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosInstance - -[internal](../modules/internal.md).AxiosInstance - -## Hierarchy - -- [`Axios`](../classes/internal.Axios.md) - - ↳ **`AxiosInstance`** - -## Callable - -### AxiosInstance - -▸ **AxiosInstance**(`config`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:188 - -### AxiosInstance - -▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -[`AxiosPromise`](internal.AxiosPromise.md)<`any`\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:189 - -## Properties - -### defaults - -• **defaults**: [`AxiosDefaults`](internal.AxiosDefaults.md)<`any`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[defaults](../classes/internal.Axios.md#defaults) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:171 - -___ - -### interceptors - -• **interceptors**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `request` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\>\> | -| `response` | [`AxiosInterceptorManager`](internal.AxiosInterceptorManager.md)<[`AxiosResponse`](internal.AxiosResponse.md)<`any`, `any`\>\> | - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[interceptors](../classes/internal.Axios.md#interceptors) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:172 - -## Methods - -### delete - -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[delete](../classes/internal.Axios.md#delete) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:179 - -___ - -### get - -▸ **get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[get](../classes/internal.Axios.md#get) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:178 - -___ - -### getUri - -▸ **getUri**(`config?`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`any`\> | - -#### Returns - -`string` - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[getUri](../classes/internal.Axios.md#geturi) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:176 - -___ - -### head - -▸ **head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[head](../classes/internal.Axios.md#head) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:180 - -___ - -### options - -▸ **options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[options](../classes/internal.Axios.md#options) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:181 - -___ - -### patch - -▸ **patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[patch](../classes/internal.Axios.md#patch) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:184 - -___ - -### post - -▸ **post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[post](../classes/internal.Axios.md#post) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:182 - -___ - -### put - -▸ **put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `url` | `string` | -| `data?` | `D` | -| `config?` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[put](../classes/internal.Axios.md#put) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:183 - -___ - -### request - -▸ **request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `R` | [`AxiosResponse`](internal.AxiosResponse.md)<`T`, `any`\> | -| `D` | `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AxiosRequestConfig`](internal.AxiosRequestConfig.md)<`D`\> | - -#### Returns - -`Promise`<`R`\> - -#### Inherited from - -[Axios](../classes/internal.Axios.md).[request](../classes/internal.Axios.md#request) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:177 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosPromise.md b/www/apps/docs/content/references/js-client/interfaces/internal.AxiosPromise.md deleted file mode 100644 index 78ca097838..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosPromise.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosPromise - -[internal](../modules/internal.md).AxiosPromise - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Hierarchy - -- `Promise`<[`AxiosResponse`](internal.AxiosResponse.md)<`T`\>\> - - ↳ **`AxiosPromise`** diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md b/www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md deleted file mode 100644 index a6fa001109..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.AxiosRequestConfig.md +++ /dev/null @@ -1,385 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: AxiosRequestConfig - -[internal](../modules/internal.md).AxiosRequestConfig - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `D` | `any` | - -## Properties - -### adapter - -• `Optional` **adapter**: [`AxiosAdapter`](internal.AxiosAdapter.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:75 - -___ - -### auth - -• `Optional` **auth**: [`AxiosBasicCredentials`](internal.AxiosBasicCredentials.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:76 - -___ - -### baseURL - -• `Optional` **baseURL**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:65 - -___ - -### cancelToken - -• `Optional` **cancelToken**: [`CancelToken`](internal.CancelToken.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:90 - -___ - -### data - -• `Optional` **data**: `D` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:71 - -___ - -### decompress - -• `Optional` **decompress**: `boolean` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:91 - -___ - -### headers - -• `Optional` **headers**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:68 - -___ - -### httpAgent - -• `Optional` **httpAgent**: `any` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:87 - -___ - -### httpsAgent - -• `Optional` **httpsAgent**: `any` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:88 - -___ - -### insecureHTTPParser - -• `Optional` **insecureHTTPParser**: `boolean` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:94 - -___ - -### maxBodyLength - -• `Optional` **maxBodyLength**: `number` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:84 - -___ - -### maxContentLength - -• `Optional` **maxContentLength**: `number` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:82 - -___ - -### maxRedirects - -• `Optional` **maxRedirects**: `number` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:85 - -___ - -### method - -• `Optional` **method**: [`Method`](../modules/internal.md#method) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:64 - -___ - -### onDownloadProgress - -• `Optional` **onDownloadProgress**: (`progressEvent`: `any`) => `void` - -#### Type declaration - -▸ (`progressEvent`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -##### Returns - -`void` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:81 - -___ - -### onUploadProgress - -• `Optional` **onUploadProgress**: (`progressEvent`: `any`) => `void` - -#### Type declaration - -▸ (`progressEvent`): `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `progressEvent` | `any` | - -##### Returns - -`void` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:80 - -___ - -### params - -• `Optional` **params**: `any` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:69 - -___ - -### paramsSerializer - -• `Optional` **paramsSerializer**: (`params`: `any`) => `string` - -#### Type declaration - -▸ (`params`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `any` | - -##### Returns - -`string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:70 - -___ - -### proxy - -• `Optional` **proxy**: ``false`` \| [`AxiosProxyConfig`](internal.AxiosProxyConfig.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:89 - -___ - -### raxConfig - -• `Optional` **raxConfig**: [`RetryConfig`](internal.RetryConfig.md) - -#### Defined in - -medusa-js/node_modules/retry-axios/dist/src/index.d.ts:89 - -___ - -### responseType - -• `Optional` **responseType**: [`ResponseType`](../modules/internal.md#responsetype) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:77 - -___ - -### signal - -• `Optional` **signal**: `AbortSignal` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:93 - -___ - -### socketPath - -• `Optional` **socketPath**: ``null`` \| `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:86 - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:72 - -___ - -### timeoutErrorMessage - -• `Optional` **timeoutErrorMessage**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:73 - -___ - -### transformRequest - -• `Optional` **transformRequest**: [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md) \| [`AxiosRequestTransformer`](internal.AxiosRequestTransformer.md)[] - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:66 - -___ - -### transformResponse - -• `Optional` **transformResponse**: [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md) \| [`AxiosResponseTransformer`](internal.AxiosResponseTransformer.md)[] - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:67 - -___ - -### transitional - -• `Optional` **transitional**: [`TransitionalOptions`](internal.TransitionalOptions.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:92 - -___ - -### url - -• `Optional` **url**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:63 - -___ - -### validateStatus - -• `Optional` **validateStatus**: ``null`` \| (`status`: `number`) => `boolean` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:83 - -___ - -### withCredentials - -• `Optional` **withCredentials**: `boolean` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:74 - -___ - -### xsrfCookieName - -• `Optional` **xsrfCookieName**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:78 - -___ - -### xsrfHeaderName - -• `Optional` **xsrfHeaderName**: `string` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:79 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.CancelToken.md b/www/apps/docs/content/references/js-client/interfaces/internal.CancelToken.md deleted file mode 100644 index fc8cfb25e2..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.CancelToken.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: CancelToken - -[internal](../modules/internal.md).CancelToken - -## Properties - -### promise - -• **promise**: `Promise`<[`Cancel`](internal.Cancel.md)\> - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:154 - -___ - -### reason - -• `Optional` **reason**: [`Cancel`](internal.Cancel.md) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:155 - -## Methods - -### throwIfRequested - -▸ **throwIfRequested**(): `void` - -#### Returns - -`void` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:156 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.Config.md b/www/apps/docs/content/references/js-client/interfaces/internal.Config.md deleted file mode 100644 index cac13872a0..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.Config.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: Config - -[internal](../modules/internal.md).Config - -## Properties - -### apiKey - -• `Optional` **apiKey**: `string` - -#### Defined in - -[medusa-js/src/request.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L17) - -___ - -### baseUrl - -• **baseUrl**: `string` - -#### Defined in - -[medusa-js/src/request.ts:15](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L15) - -___ - -### maxRetries - -• **maxRetries**: `number` - -#### Defined in - -[medusa-js/src/request.ts:16](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L16) - -___ - -### publishableApiKey - -• `Optional` **publishableApiKey**: `string` - -#### Defined in - -[medusa-js/src/request.ts:18](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L18) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.HTTPResponse.md b/www/apps/docs/content/references/js-client/interfaces/internal.HTTPResponse.md deleted file mode 100644 index 1ed689e47e..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.HTTPResponse.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: HTTPResponse - -[internal](../modules/internal.md).HTTPResponse - -## Properties - -### config - -• **config**: `any` - -#### Defined in - -[medusa-js/src/typings.ts:13](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L13) - -___ - -### headers - -• **headers**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] } - -#### Defined in - -[medusa-js/src/typings.ts:10](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L10) - -___ - -### request - -• `Optional` **request**: `any` - -#### Defined in - -[medusa-js/src/typings.ts:14](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L14) - -___ - -### status - -• **status**: `number` - -#### Defined in - -[medusa-js/src/typings.ts:8](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L8) - -___ - -### statusText - -• **statusText**: `string` - -#### Defined in - -[medusa-js/src/typings.ts:9](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L9) diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md b/www/apps/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md deleted file mode 100644 index d870ed1e0f..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.HeadersDefaults.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: HeadersDefaults - -[internal](../modules/internal.md).HeadersDefaults - -## Properties - -### common - -• **common**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:98 - -___ - -### delete - -• **delete**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:99 - -___ - -### get - -• **get**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:100 - -___ - -### head - -• **head**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:101 - -___ - -### link - -• `Optional` **link**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:107 - -___ - -### options - -• `Optional` **options**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:105 - -___ - -### patch - -• **patch**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:104 - -___ - -### post - -• **post**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:102 - -___ - -### purge - -• `Optional` **purge**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:106 - -___ - -### put - -• **put**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:103 - -___ - -### unlink - -• `Optional` **unlink**: [`AxiosRequestHeaders`](../modules/internal.md#axiosrequestheaders) - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:108 diff --git a/www/apps/docs/content/references/js-client/interfaces/internal.RequestOptions.md b/www/apps/docs/content/references/js-client/interfaces/internal.RequestOptions.md deleted file mode 100644 index e21606bf45..0000000000 --- a/www/apps/docs/content/references/js-client/interfaces/internal.RequestOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -displayed_sidebar: jsClientSidebar ---- - -# Interface: RequestOptions - -[internal](../modules/internal.md).RequestOptions - -## Properties - -### numberOfRetries - -• `Optional` **numberOfRetries**: `number` - -#### Defined in - -[medusa-js/src/request.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L23) - -___ - -### timeout - -• `Optional` **timeout**: `number` - -#### Defined in - -[medusa-js/src/request.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L22) diff --git a/www/apps/docs/content/references/js-client/modules/internal-1.md b/www/apps/docs/content/references/js-client/modules/internal-1.md index bd10fb9e18..06a979ddea 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-1.md +++ b/www/apps/docs/content/references/js-client/modules/internal-1.md @@ -1,4 +1,8 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal ## Enumerations @@ -7,6 +11,8 @@ ## Classes - [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md) +- [BaseEntity](../classes/internal-1.BaseEntity.md) +- [SoftDeletableEntity](../classes/internal-1.SoftDeletableEntity.md) - [User](../classes/internal-1.User.md) ## Type Aliases @@ -15,12 +21,105 @@ Ƭ **AdminAuthRes**: `Object` +**`Schema`** + +AdminAuthRes +type: object +required: + - user +properties: + user: + description: User details. + $ref: "#/components/schemas/User" + #### Type declaration | Name | Type | | :------ | :------ | -| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | +| `user` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | #### Defined in -medusa/dist/api/routes/admin/auth/index.d.ts:4 +packages/medusa/dist/api/routes/admin/auth/index.d.ts:14 + +___ + +### AdminBearerAuthRes + +Ƭ **AdminBearerAuthRes**: `Object` + +**`Schema`** + +AdminBearerAuthRes +type: object +properties: + accessToken: + description: Access token for subsequent authorization. + type: string + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `access_token` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/auth/index.d.ts:25 + +___ + +### Exclude + +Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` + +Exclude from T those types that are assignable to U + +#### Type parameters + +| Name | +| :------ | +| `T` | +| `U` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1606 + +___ + +### Omit + +Ƭ **Omit**<`T`, `K`\>: [`Pick`](internal-1.md#pick)<`T`, [`Exclude`](internal-1.md#exclude)\> + +Construct a type with the properties of T except for those in type K. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `any` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1616 + +___ + +### Pick + +Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } + +From T, pick a set of properties whose keys are in the union K + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `T` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1592 diff --git a/www/apps/docs/content/references/js-client/modules/internal-10.md b/www/apps/docs/content/references/js-client/modules/internal-10.md index fcf99d2add..aa273bb437 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-10.md +++ b/www/apps/docs/content/references/js-client/modules/internal-10.md @@ -1,44 +1,484 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- -## Classes +# Module: internal -- [AdminPostInvitesInviteAcceptReq](../classes/internal-10.AdminPostInvitesInviteAcceptReq.md) -- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md) -- [AdminPostInvitesReq](../classes/internal-10.AdminPostInvitesReq.md) -- [Invite](../classes/internal-10.Invite.md) +## Interfaces + +- [BlobPropertyBag](../interfaces/internal-10.BlobPropertyBag.md) +- [File](../interfaces/internal-10.File.md) +- [FilePropertyBag](../interfaces/internal-10.FilePropertyBag.md) +- [QueuingStrategy](../interfaces/internal-10.QueuingStrategy.md) +- [QueuingStrategySize](../interfaces/internal-10.QueuingStrategySize.md) +- [ReadableByteStreamController](../interfaces/internal-10.ReadableByteStreamController.md) +- [ReadableStream](../interfaces/internal-10.ReadableStream.md) +- [ReadableStreamBYOBReader](../interfaces/internal-10.ReadableStreamBYOBReader.md) +- [ReadableStreamBYOBRequest](../interfaces/internal-10.ReadableStreamBYOBRequest.md) +- [ReadableStreamDefaultController](../interfaces/internal-10.ReadableStreamDefaultController.md) +- [ReadableStreamDefaultReader](../interfaces/internal-10.ReadableStreamDefaultReader.md) +- [ReadableStreamGenericReader](../interfaces/internal-10.ReadableStreamGenericReader.md) +- [ReadableStreamGetReaderOptions](../interfaces/internal-10.ReadableStreamGetReaderOptions.md) +- [ReadableStreamReadDoneResult](../interfaces/internal-10.ReadableStreamReadDoneResult.md) +- [ReadableStreamReadValueResult](../interfaces/internal-10.ReadableStreamReadValueResult.md) +- [ReadableWritablePair](../interfaces/internal-10.ReadableWritablePair.md) +- [StreamPipeOptions](../interfaces/internal-10.StreamPipeOptions.md) +- [UnderlyingByteSource](../interfaces/internal-10.UnderlyingByteSource.md) +- [UnderlyingDefaultSource](../interfaces/internal-10.UnderlyingDefaultSource.md) +- [UnderlyingSink](../interfaces/internal-10.UnderlyingSink.md) +- [UnderlyingSinkAbortCallback](../interfaces/internal-10.UnderlyingSinkAbortCallback.md) +- [UnderlyingSinkCloseCallback](../interfaces/internal-10.UnderlyingSinkCloseCallback.md) +- [UnderlyingSinkStartCallback](../interfaces/internal-10.UnderlyingSinkStartCallback.md) +- [UnderlyingSinkWriteCallback](../interfaces/internal-10.UnderlyingSinkWriteCallback.md) +- [UnderlyingSource](../interfaces/internal-10.UnderlyingSource.md) +- [UnderlyingSourceCancelCallback](../interfaces/internal-10.UnderlyingSourceCancelCallback.md) +- [UnderlyingSourcePullCallback](../interfaces/internal-10.UnderlyingSourcePullCallback.md) +- [UnderlyingSourceStartCallback](../interfaces/internal-10.UnderlyingSourceStartCallback.md) +- [WritableStream](../interfaces/internal-10.WritableStream.md) +- [WritableStreamDefaultController](../interfaces/internal-10.WritableStreamDefaultController.md) +- [WritableStreamDefaultWriter](../interfaces/internal-10.WritableStreamDefaultWriter.md) ## Type Aliases -### AdminListInvitesRes +### AdminCreateUploadPayload -Ƭ **AdminListInvitesRes**: `Object` +Ƭ **AdminCreateUploadPayload**: [`File`](internal-10.md#file) \| [`File`](internal-10.md#file)[] + +#### Defined in + +[packages/medusa-js/src/typings.ts:51](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L51) + +___ + +### BlobPart + +Ƭ **BlobPart**: [`BufferSource`](internal-10.md#buffersource) \| `Blob` \| `string` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:27961 + +___ + +### BufferSource + +Ƭ **BufferSource**: [`ArrayBufferView`](../interfaces/internal-8.ArrayBufferView.md) \| `ArrayBuffer` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:27963 + +___ + +### EndingType + +Ƭ **EndingType**: ``"native"`` \| ``"transparent"`` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:28077 + +___ + +### ReadableStreamController + +Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller) + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:28012 + +___ + +### ReadableStreamReadResult + +Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../interfaces/internal-10.ReadableStreamReadValueResult.md)<`T`\> \| [`ReadableStreamReadDoneResult`](../interfaces/internal-10.ReadableStreamReadDoneResult.md)<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:28013 + +___ + +### ReadableStreamReader + +Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader) + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:28014 + +## Variables + +### File + +• **File**: `Object` + +#### Call signature + +• **new File**(`fileBits`, `fileName`, `options?`): [`File`](internal-10.md#file) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `fileBits` | [`BlobPart`](internal-10.md#blobpart)[] | +| `fileName` | `string` | +| `options?` | [`FilePropertyBag`](../interfaces/internal-10.FilePropertyBag.md) | + +##### Returns + +[`File`](internal-10.md#file) #### Type declaration | Name | Type | | :------ | :------ | -| `invites` | [`Invite`](../classes/internal-10.Invite.md)[] | +| `prototype` | [`File`](internal-10.md#file) | #### Defined in -medusa/dist/api/routes/admin/invites/index.d.ts:8 +docs-util/node_modules/typescript/lib/lib.dom.d.ts:8260 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:8269 ___ -### AdminPostInvitesPayload +### ReadableByteStreamController -Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-10.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-10.md#inviteuserrolesenum) } +• **ReadableByteStreamController**: `Object` + +#### Call signature + +• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller) + +##### Returns + +[`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableByteStreamController`](internal-10.md#readablebytestreamcontroller) | #### Defined in -[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L47) +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18464 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18477 ___ -### InviteUserRolesEnum +### ReadableStream -Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` +• **ReadableStream**: `Object` + +#### Call signature + +• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`Uint8Array`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSource` | [`UnderlyingByteSource`](../interfaces/internal-10.UnderlyingByteSource.md) | +| `strategy?` | `Object` | +| `strategy.highWaterMark?` | `number` | + +##### Returns + +[`ReadableStream`](internal-10.md#readablestream)<`Uint8Array`\> + +• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`R`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSource` | [`UnderlyingDefaultSource`](../interfaces/internal-10.UnderlyingDefaultSource.md)<`R`\> | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`R`\> | + +##### Returns + +[`ReadableStream`](internal-10.md#readablestream)<`R`\> + +• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](internal-10.md#readablestream)<`R`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSource?` | [`UnderlyingSource`](../interfaces/internal-10.UnderlyingSource.md)<`R`\> | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`R`\> | + +##### Returns + +[`ReadableStream`](internal-10.md#readablestream)<`R`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStream`](internal-10.md#readablestream)<`any`\> | #### Defined in -[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L45) +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18487 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18504 + +___ + +### ReadableStreamBYOBReader + +• **ReadableStreamBYOBReader**: `Object` + +#### Call signature + +• **new ReadableStreamBYOBReader**(`stream`): [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader) + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](internal-10.md#readablestream)<`any`\> | + +##### Returns + +[`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamBYOBReader`](internal-10.md#readablestreambyobreader) | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18512 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18519 + +___ + +### ReadableStreamBYOBRequest + +• **ReadableStreamBYOBRequest**: `Object` + +#### Call signature + +• **new ReadableStreamBYOBRequest**(): [`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest) + +##### Returns + +[`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamBYOBRequest`](internal-10.md#readablestreambyobrequest) | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18525 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18534 + +___ + +### ReadableStreamDefaultController + +• **ReadableStreamDefaultController**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\> + +##### Returns + +[`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamDefaultController`](internal-10.md#readablestreamdefaultcontroller)<`any`\> | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18540 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18551 + +___ + +### ReadableStreamDefaultReader + +• **ReadableStreamDefaultReader**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`R`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](internal-10.md#readablestream)<`R`\> | + +##### Returns + +[`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`R`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamDefaultReader`](internal-10.md#readablestreamdefaultreader)<`any`\> | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18557 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:18564 + +___ + +### WritableStream + +• **WritableStream**: `Object` + +#### Call signature + +• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](internal-10.md#writablestream)<`W`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSink?` | [`UnderlyingSink`](../interfaces/internal-10.UnderlyingSink.md)<`W`\> | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-10.QueuingStrategy.md)<`W`\> | + +##### Returns + +[`WritableStream`](internal-10.md#writablestream)<`W`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStream`](internal-10.md#writablestream)<`any`\> | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26020 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26031 + +___ + +### WritableStreamDefaultController + +• **WritableStreamDefaultController**: `Object` + +#### Call signature + +• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller) + +##### Returns + +[`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStreamDefaultController`](internal-10.md#writablestreamdefaultcontroller) | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26041 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26048 + +___ + +### WritableStreamDefaultWriter + +• **WritableStreamDefaultWriter**: `Object` + +#### Call signature + +• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`W`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`WritableStream`](internal-10.md#writablestream)<`W`\> | + +##### Returns + +[`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`W`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStreamDefaultWriter`](internal-10.md#writablestreamdefaultwriter)<`any`\> | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26058 + +docs-util/node_modules/typescript/lib/lib.dom.d.ts:26075 diff --git a/www/apps/docs/content/references/js-client/modules/internal-11.md b/www/apps/docs/content/references/js-client/modules/internal-11.md index b6a49bb92d..fdb39cbaee 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-11.md +++ b/www/apps/docs/content/references/js-client/modules/internal-11.md @@ -1,34 +1,81 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- -## Classes - -- [AdminGetNotesParams](../classes/internal-11.AdminGetNotesParams.md) -- [AdminPostNotesNoteReq](../classes/internal-11.AdminPostNotesNoteReq.md) -- [AdminPostNotesReq](../classes/internal-11.AdminPostNotesReq.md) -- [Note](../classes/internal-11.Note.md) +# Module: internal ## Type Aliases -### AdminNotesListRes +### AdminCreateUserPayload -Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] } +Ƭ **AdminCreateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-11.md#createuserroles) } #### Defined in -medusa/dist/api/routes/admin/notes/index.d.ts:10 +[packages/medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L31) ___ -### AdminNotesRes +### AdminUpdateUserPayload -Ƭ **AdminNotesRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `note` | [`Note`](../classes/internal-11.Note.md) | +Ƭ **AdminUpdateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-11.md#updateuserroles) } #### Defined in -medusa/dist/api/routes/admin/notes/index.d.ts:6 +[packages/medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L41) + +___ + +### CreateUserRoles + +Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` + +#### Defined in + +[packages/medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L28) + +___ + +### CreateUserRolesEnum + +Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md)[``"role"``]\> + +#### Defined in + +[packages/medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L25) + +___ + +### NoUndefined + +Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[packages/medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L23) + +___ + +### UpdateUserRoles + +Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + +#### Defined in + +[packages/medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L39) + +___ + +### UpdateUserRolesEnum + +Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md)[``"role"``]\> + +#### Defined in + +[packages/medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L37) diff --git a/www/apps/docs/content/references/js-client/modules/internal-12.md b/www/apps/docs/content/references/js-client/modules/internal-12.md index 5ddb222efc..ce1453a92a 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-12.md +++ b/www/apps/docs/content/references/js-client/modules/internal-12.md @@ -1,40 +1,113 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal ## Classes -- [AdminGetNotificationsParams](../classes/internal-12.AdminGetNotificationsParams.md) -- [AdminPostNotificationsNotificationResendReq](../classes/internal-12.AdminPostNotificationsNotificationResendReq.md) -- [Notification](../classes/internal-12.Notification.md) -- [NotificationProvider](../classes/internal-12.NotificationProvider.md) +- [Axios](../classes/internal-12.Axios.md) +- [Client](../classes/internal-12.Client.md) + +## Interfaces + +- [AxiosAdapter](../interfaces/internal-12.AxiosAdapter.md) +- [AxiosBasicCredentials](../interfaces/internal-12.AxiosBasicCredentials.md) +- [AxiosDefaults](../interfaces/internal-12.AxiosDefaults.md) +- [AxiosError](../interfaces/internal-12.AxiosError.md) +- [AxiosInstance](../interfaces/internal-12.AxiosInstance.md) +- [AxiosInterceptorManager](../interfaces/internal-12.AxiosInterceptorManager.md) +- [AxiosPromise](../interfaces/internal-12.AxiosPromise.md) +- [AxiosProxyConfig](../interfaces/internal-12.AxiosProxyConfig.md) +- [AxiosRequestTransformer](../interfaces/internal-12.AxiosRequestTransformer.md) +- [AxiosResponse](../interfaces/internal-12.AxiosResponse.md) +- [AxiosResponseTransformer](../interfaces/internal-12.AxiosResponseTransformer.md) +- [Cancel](../interfaces/internal-12.Cancel.md) +- [CancelToken](../interfaces/internal-12.CancelToken.md) +- [Config](../interfaces/internal-12.Config.md) +- [HTTPResponse](../interfaces/internal-12.HTTPResponse.md) +- [HeadersDefaults](../interfaces/internal-12.HeadersDefaults.md) +- [RetryConfig](../interfaces/internal-12.RetryConfig.md) +- [TransitionalOptions](../interfaces/internal-12.TransitionalOptions.md) ## Type Aliases -### AdminNotificationsListRes +### AxiosRequestHeaders -Ƭ **AdminNotificationsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `notifications` | [`Notification`](../classes/internal-12.Notification.md)[] | +Ƭ **AxiosRequestHeaders**: [`Record`](internal.md#record)<`string`, `string`\> #### Defined in -medusa/dist/api/routes/admin/notifications/index.d.ts:8 +packages/medusa-js/node_modules/axios/index.d.ts:3 ___ -### AdminNotificationsRes +### AxiosResponseHeaders -Ƭ **AdminNotificationsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `notification` | [`Notification`](../classes/internal-12.Notification.md) | +Ƭ **AxiosResponseHeaders**: [`Record`](internal.md#record)<`string`, `string`\> & { `set-cookie?`: `string`[] } #### Defined in -medusa/dist/api/routes/admin/notifications/index.d.ts:11 +packages/medusa-js/node_modules/axios/index.d.ts:5 + +___ + +### Method + +Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:36 + +___ + +### RequestMethod + +Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` + +#### Defined in + +[packages/medusa-js/src/request.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/request.ts#L28) + +___ + +### Response + +Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal-12.HTTPResponse.md) } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[packages/medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L17) + +___ + +### ResponsePromise + +Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal-12.md#response)<`T`\>\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `any` | + +#### Defined in + +[packages/medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L21) + +___ + +### ResponseType + +Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` + +#### Defined in + +packages/medusa-js/node_modules/axios/index.d.ts:48 diff --git a/www/apps/docs/content/references/js-client/modules/internal-13.md b/www/apps/docs/content/references/js-client/modules/internal-13.md deleted file mode 100644 index d02fbbbff5..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-13.md +++ /dev/null @@ -1,64 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md) -- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md) -- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md) -- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md) -- [GetOrderEditsOrderEditParams](../classes/internal-13.GetOrderEditsOrderEditParams.md) -- [GetOrderEditsParams](../classes/internal-13.GetOrderEditsParams.md) - -## Type Aliases - -### AdminOrderEditItemChangeDeleteRes - -Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `id` | `string` | -| `object` | ``"item_change"`` | - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/index.d.ts:12 - -___ - -### AdminOrderEditsListRes - -Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal.OrderEdit.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/index.d.ts:8 - -___ - -### AdminOrderEditsRes - -Ƭ **AdminOrderEditsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order_edit` | [`OrderEdit`](../classes/internal.OrderEdit.md) | - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/index.d.ts:5 - -## Variables - -### GetOrderEditsParams\_base - -• `Const` **GetOrderEditsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:71 diff --git a/www/apps/docs/content/references/js-client/modules/internal-14.md b/www/apps/docs/content/references/js-client/modules/internal-14.md deleted file mode 100644 index 723baa2d82..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-14.md +++ /dev/null @@ -1,62 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdditionalItem](../classes/internal-14.AdditionalItem.md) -- [AdditionalItem](../classes/internal-14.AdditionalItem-1.md) -- [AdminGetOrdersParams](../classes/internal-14.AdminGetOrdersParams.md) -- [AdminListOrdersSelector](../classes/internal-14.AdminListOrdersSelector.md) -- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) -- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md) -- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) -- [AdminPostOrdersOrderClaimsReq](../classes/internal-14.AdminPostOrdersOrderClaimsReq.md) -- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md) -- [AdminPostOrdersOrderRefundsReq](../classes/internal-14.AdminPostOrdersOrderRefundsReq.md) -- [AdminPostOrdersOrderReq](../classes/internal-14.AdminPostOrdersOrderReq.md) -- [AdminPostOrdersOrderReturnsReq](../classes/internal-14.AdminPostOrdersOrderReturnsReq.md) -- [AdminPostOrdersOrderShipmentReq](../classes/internal-14.AdminPostOrdersOrderShipmentReq.md) -- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md) -- [AdminPostOrdersOrderSwapsReq](../classes/internal-14.AdminPostOrdersOrderSwapsReq.md) -- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) -- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) -- [CustomShippingOption](../classes/internal-14.CustomShippingOption.md) -- [Image](../classes/internal-14.Image.md) -- [Item](../classes/internal-14.Item.md) -- [Item](../classes/internal-14.Item-1.md) -- [Item](../classes/internal-14.Item-2.md) -- [OrdersReturnItem](../classes/internal-14.OrdersReturnItem.md) -- [PaymentMethod](../classes/internal-14.PaymentMethod.md) -- [ReturnItem](../classes/internal-14.ReturnItem.md) -- [ReturnShipping](../classes/internal-14.ReturnShipping.md) -- [ReturnShipping](../classes/internal-14.ReturnShipping-1.md) -- [ReturnShipping](../classes/internal-14.ReturnShipping-2.md) -- [ShippingMethod](../classes/internal-14.ShippingMethod.md) -- [ShippingMethod](../classes/internal-14.ShippingMethod-1.md) -- [ShippingMethod](../classes/internal-14.ShippingMethod-2.md) -- [Tag](../classes/internal-14.Tag.md) - -## Type Aliases - -### AdminOrdersListRes - -Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/orders/index.d.ts:11 - -___ - -### AdminOrdersRes - -Ƭ **AdminOrdersRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | - -#### Defined in - -medusa/dist/api/routes/admin/orders/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-15.md b/www/apps/docs/content/references/js-client/modules/internal-15.md deleted file mode 100644 index f2e9c64f84..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-15.md +++ /dev/null @@ -1,40 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminUpdatePaymentCollectionsReq](../classes/internal-15.AdminUpdatePaymentCollectionsReq.md) -- [GetPaymentCollectionsParams](../classes/internal-15.GetPaymentCollectionsParams.md) - -## Type Aliases - -### AdminPaymentCollectionDeleteRes - -Ƭ **AdminPaymentCollectionDeleteRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `id` | `string` | -| `object` | ``"payment_collection"`` | - -#### Defined in - -medusa/dist/api/routes/admin/payment-collections/index.d.ts:10 - -___ - -### AdminPaymentCollectionsRes - -Ƭ **AdminPaymentCollectionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) | - -#### Defined in - -medusa/dist/api/routes/admin/payment-collections/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-16.md b/www/apps/docs/content/references/js-client/modules/internal-16.md deleted file mode 100644 index 57cb9c9bdd..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-16.md +++ /dev/null @@ -1,42 +0,0 @@ -# Namespace: internal - -## Enumerations - -- [RefundReason](../enums/internal-16.RefundReason.md) - -## Classes - -- [AdminPostPaymentRefundsReq](../classes/internal-16.AdminPostPaymentRefundsReq.md) -- [GetPaymentsParams](../classes/internal-16.GetPaymentsParams.md) - -## Type Aliases - -### AdminPaymentRes - -Ƭ **AdminPaymentRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment` | [`Payment`](../classes/internal.Payment.md) | - -#### Defined in - -medusa/dist/api/routes/admin/payments/index.d.ts:6 - -___ - -### AdminRefundRes - -Ƭ **AdminRefundRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `refund` | [`Refund`](../classes/internal.Refund.md) | - -#### Defined in - -medusa/dist/api/routes/admin/payments/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-17.md b/www/apps/docs/content/references/js-client/modules/internal-17.md deleted file mode 100644 index 50a75a5c31..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-17.md +++ /dev/null @@ -1,69 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminDeletePriceListPricesPricesReq](../classes/internal-17.AdminDeletePriceListPricesPricesReq.md) -- [AdminGetPriceListPaginationParams](../classes/internal-17.AdminGetPriceListPaginationParams.md) -- [AdminGetPriceListsPriceListProductsParams](../classes/internal-17.AdminGetPriceListsPriceListProductsParams.md) -- [AdminPostPriceListPricesPricesReq](../classes/internal-17.AdminPostPriceListPricesPricesReq.md) -- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md) -- [AdminPostPriceListsPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListReq.md) -- [AdminPriceListPricesCreateReq](../classes/internal-17.AdminPriceListPricesCreateReq.md) -- [AdminPriceListPricesUpdateReq](../classes/internal-17.AdminPriceListPricesUpdateReq.md) -- [CustomerGroup](../classes/internal-17.CustomerGroup.md) -- [CustomerGroup](../classes/internal-17.CustomerGroup-1.md) -- [FilterablePriceListProps](../classes/internal-17.FilterablePriceListProps.md) - -## Type Aliases - -### AdminPriceListDeleteBatchRes - -Ƭ **AdminPriceListDeleteBatchRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `ids` | `string`[] | -| `object` | `string` | - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/index.d.ts:13 - -___ - -### AdminPriceListRes - -Ƭ **AdminPriceListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `price_list` | [`PriceList`](../classes/internal.PriceList.md) | - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/index.d.ts:10 - -___ - -### AdminPriceListsListRes - -Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/index.d.ts:21 - -## Variables - -### AdminGetPriceListsPriceListProductsParams\_base - -• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:175 diff --git a/www/apps/docs/content/references/js-client/modules/internal-18.md b/www/apps/docs/content/references/js-client/modules/internal-18.md deleted file mode 100644 index 51571db277..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-18.md +++ /dev/null @@ -1,16 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetProductTagsPaginationParams](../classes/internal-18.AdminGetProductTagsPaginationParams.md) -- [AdminGetProductTagsParams](../classes/internal-18.AdminGetProductTagsParams.md) - -## Type Aliases - -### AdminProductTagsListRes - -Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/product-tags/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-19.md b/www/apps/docs/content/references/js-client/modules/internal-19.md deleted file mode 100644 index 5bc00b07e5..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-19.md +++ /dev/null @@ -1,15 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetProductTypesParams](../classes/internal-19.AdminGetProductTypesParams.md) - -## Type Aliases - -### AdminProductTypesListRes - -Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/product-types/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-2.md b/www/apps/docs/content/references/js-client/modules/internal-2.md index 2eda5e731a..eebfc9e006 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-2.md +++ b/www/apps/docs/content/references/js-client/modules/internal-2.md @@ -1,4 +1,8 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal ## Enumerations @@ -18,9 +22,34 @@ Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../classes/internal-2.BatchJob.md)[] } +**`Schema`** + +AdminBatchJobListRes +type: object +required: + - batch_jobs + - count + - offset + - limit +properties: + batch_jobs: + type: array + description: An array of batch job details. + items: + $ref: "#/components/schemas/BatchJob" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of batch jobs skipped when retrieving the batch jobs. + limit: + type: integer + description: The number of items per page + #### Defined in -medusa/dist/api/routes/admin/batch/index.d.ts:9 +packages/medusa/dist/api/routes/admin/batch/index.d.ts:42 ___ @@ -28,6 +57,17 @@ ___ Ƭ **AdminBatchJobRes**: `Object` +**`Schema`** + +AdminBatchJobRes +type: object +required: + - batch_job +properties: + batch_job: + description: Batch job details. + $ref: "#/components/schemas/BatchJob" + #### Type declaration | Name | Type | @@ -36,7 +76,7 @@ ___ #### Defined in -medusa/dist/api/routes/admin/batch/index.d.ts:5 +packages/medusa/dist/api/routes/admin/batch/index.d.ts:15 ___ @@ -57,7 +97,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:18 +packages/medusa/dist/types/batch-job.d.ts:18 ___ @@ -75,7 +115,7 @@ ___ #### Defined in -medusa/dist/types/batch-job.d.ts:23 +packages/medusa/dist/types/batch-job.d.ts:23 ___ @@ -93,4 +133,4 @@ ___ #### Defined in -medusa/dist/types/common.d.ts:60 +packages/medusa/dist/types/common.d.ts:70 diff --git a/www/apps/docs/content/references/js-client/modules/internal-20.md b/www/apps/docs/content/references/js-client/modules/internal-20.md deleted file mode 100644 index a9535c89ca..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-20.md +++ /dev/null @@ -1,211 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetProductsParams](../classes/internal-20.AdminGetProductsParams.md) -- [AdminPostProductsProductMetadataReq](../classes/internal-20.AdminPostProductsProductMetadataReq.md) -- [AdminPostProductsProductOptionsOption](../classes/internal-20.AdminPostProductsProductOptionsOption.md) -- [AdminPostProductsProductOptionsReq](../classes/internal-20.AdminPostProductsProductOptionsReq.md) -- [AdminPostProductsProductReq](../classes/internal-20.AdminPostProductsProductReq.md) -- [AdminPostProductsProductVariantsReq](../classes/internal-20.AdminPostProductsProductVariantsReq.md) -- [AdminPostProductsProductVariantsVariantReq](../classes/internal-20.AdminPostProductsProductVariantsVariantReq.md) -- [AdminPostProductsReq](../classes/internal-20.AdminPostProductsReq.md) -- [FilterableProductProps](../classes/internal-20.FilterableProductProps.md) -- [ProductOptionReq](../classes/internal-20.ProductOptionReq.md) -- [ProductSalesChannelReq](../classes/internal-20.ProductSalesChannelReq.md) -- [ProductTagReq](../classes/internal-20.ProductTagReq.md) -- [ProductTypeReq](../classes/internal-20.ProductTypeReq.md) -- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq.md) -- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-1.md) -- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-2.md) -- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-3.md) -- [ProductVariantPricesCreateReq](../classes/internal-20.ProductVariantPricesCreateReq.md) -- [ProductVariantPricesUpdateReq](../classes/internal-20.ProductVariantPricesUpdateReq.md) -- [ProductVariantReq](../classes/internal-20.ProductVariantReq.md) -- [ProductVariantReq](../classes/internal-20.ProductVariantReq-1.md) - -## Type Aliases - -### AdminProductsDeleteOptionRes - -Ƭ **AdminProductsDeleteOptionRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `object` | ``"option"`` | -| `option_id` | `string` | -| `product` | [`Product`](../classes/internal.Product.md) | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:13 - -___ - -### AdminProductsDeleteRes - -Ƭ **AdminProductsDeleteRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `id` | `string` | -| `object` | ``"product"`` | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:25 - -___ - -### AdminProductsDeleteVariantRes - -Ƭ **AdminProductsDeleteVariantRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `deleted` | `boolean` | -| `object` | ``"product-variant"`` | -| `product` | [`Product`](../classes/internal.Product.md) | -| `variant_id` | `string` | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:19 - -___ - -### AdminProductsListRes - -Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-20.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] } - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:30 - -___ - -### AdminProductsListTagsRes - -Ƭ **AdminProductsListTagsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:36 - -___ - -### AdminProductsListTypesRes - -Ƭ **AdminProductsListTypesRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `types` | [`ProductType`](../classes/internal.ProductType.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:33 - -___ - -### AdminProductsRes - -Ƭ **AdminProductsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `product` | [`Product`](../classes/internal.Product.md) | - -#### Defined in - -medusa/dist/api/routes/admin/products/index.d.ts:39 - -___ - -### PricedProduct - -Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] } - -#### Defined in - -medusa/dist/types/pricing.d.ts:31 - -___ - -### PricedVariant - -Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-20.md#productvariantpricing) - -#### Defined in - -medusa/dist/types/pricing.d.ts:30 - -___ - -### ProductVariantPricing - -Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-20.md#taxedpricing) - -#### Defined in - -medusa/dist/types/pricing.d.ts:4 - -___ - -### TaxServiceRate - -Ƭ **TaxServiceRate**: `Object` - -The tax rate object as configured in Medusa. These may have an unspecified -numerical rate as they may be used for lookup purposes in the tax provider -plugin. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `code` | `string` \| ``null`` | -| `name` | `string` | -| `rate?` | `number` \| ``null`` | - -#### Defined in - -medusa/dist/types/tax-service.d.ts:15 - -___ - -### TaxedPricing - -Ƭ **TaxedPricing**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `calculated_price_incl_tax` | `number` \| ``null`` | -| `calculated_tax` | `number` \| ``null`` | -| `original_price_incl_tax` | `number` \| ``null`` | -| `original_tax` | `number` \| ``null`` | -| `tax_rates` | [`TaxServiceRate`](internal-20.md#taxservicerate)[] \| ``null`` | - -#### Defined in - -medusa/dist/types/pricing.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/modules/internal-21.md b/www/apps/docs/content/references/js-client/modules/internal-21.md deleted file mode 100644 index a2ab812eae..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-21.md +++ /dev/null @@ -1,58 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) -- [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md) -- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md) -- [AdminPostPublishableApiKeysReq](../classes/internal-21.AdminPostPublishableApiKeysReq.md) -- [GetPublishableApiKeySalesChannelsParams](../classes/internal-21.GetPublishableApiKeySalesChannelsParams.md) -- [GetPublishableApiKeysParams](../classes/internal-21.GetPublishableApiKeysParams.md) -- [ProductBatchSalesChannel](../classes/internal-21.ProductBatchSalesChannel.md) -- [PublishableApiKey](../classes/internal-21.PublishableApiKey.md) - -## Type Aliases - -### AdminPublishableApiKeysListRes - -Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:8 - -___ - -### AdminPublishableApiKeysRes - -Ƭ **AdminPublishableApiKeysRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md) | - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:5 - -___ - -### AdminSalesChannelsListRes - -Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/index.d.ts:10 - -## Variables - -### GetPublishableApiKeysParams\_base - -• `Const` **GetPublishableApiKeysParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61 diff --git a/www/apps/docs/content/references/js-client/modules/internal-22.md b/www/apps/docs/content/references/js-client/modules/internal-22.md deleted file mode 100644 index 07a8b23a1e..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-22.md +++ /dev/null @@ -1,24 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetRegionsPaginationParams](../classes/internal-22.AdminGetRegionsPaginationParams.md) -- [AdminGetRegionsParams](../classes/internal-22.AdminGetRegionsParams.md) -- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md) -- [AdminPostRegionsRegionCountriesReq](../classes/internal-22.AdminPostRegionsRegionCountriesReq.md) -- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) -- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) -- [AdminPostRegionsRegionReq](../classes/internal-22.AdminPostRegionsRegionReq.md) -- [AdminPostRegionsReq](../classes/internal-22.AdminPostRegionsReq.md) -- [AdminRegionsRes](../classes/internal-22.AdminRegionsRes.md) -- [FulfillmentOption](../classes/internal-22.FulfillmentOption.md) - -## Type Aliases - -### AdminRegionsListRes - -Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/regions/index.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/modules/internal-23.md b/www/apps/docs/content/references/js-client/modules/internal-23.md deleted file mode 100644 index aaeb8f6c1d..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-23.md +++ /dev/null @@ -1,38 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminPostReturnReasonsReasonReq](../classes/internal-23.AdminPostReturnReasonsReasonReq.md) -- [AdminPostReturnReasonsReq](../classes/internal-23.AdminPostReturnReasonsReq.md) - -## Type Aliases - -### AdminReturnReasonsListRes - -Ƭ **AdminReturnReasonsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/index.d.ts:10 - -___ - -### AdminReturnReasonsRes - -Ƭ **AdminReturnReasonsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | - -#### Defined in - -medusa/dist/api/routes/admin/return-reasons/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-24.md b/www/apps/docs/content/references/js-client/modules/internal-24.md deleted file mode 100644 index e016461177..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-24.md +++ /dev/null @@ -1,49 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetReturnsParams](../classes/internal-24.AdminGetReturnsParams.md) -- [AdminPostReturnsReturnReceiveReq](../classes/internal-24.AdminPostReturnsReturnReceiveReq.md) -- [Item](../classes/internal-24.Item.md) - -## Type Aliases - -### AdminReturnsCancelRes - -Ƭ **AdminReturnsCancelRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | - -#### Defined in - -medusa/dist/api/routes/admin/returns/index.d.ts:6 - -___ - -### AdminReturnsListRes - -Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/returns/index.d.ts:9 - -___ - -### AdminReturnsRes - -Ƭ **AdminReturnsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return` | [`Return`](../classes/internal.Return.md) | - -#### Defined in - -medusa/dist/api/routes/admin/returns/index.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/modules/internal-25.md b/www/apps/docs/content/references/js-client/modules/internal-25.md deleted file mode 100644 index 27f05f89e7..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-25.md +++ /dev/null @@ -1,35 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md) -- [AdminGetSalesChannelsParams](../classes/internal-25.AdminGetSalesChannelsParams.md) -- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md) -- [AdminPostSalesChannelsReq](../classes/internal-25.AdminPostSalesChannelsReq.md) -- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md) - -## Type Aliases - -### AdminSalesChannelsRes - -Ƭ **AdminSalesChannelsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) | - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/index.d.ts:6 - -## Variables - -### AdminGetSalesChannelsParams\_base - -• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:142 diff --git a/www/apps/docs/content/references/js-client/modules/internal-26.md b/www/apps/docs/content/references/js-client/modules/internal-26.md deleted file mode 100644 index 8f01dd1821..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-26.md +++ /dev/null @@ -1,35 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetShippingOptionsParams](../classes/internal-26.AdminGetShippingOptionsParams.md) -- [AdminPostShippingOptionsOptionReq](../classes/internal-26.AdminPostShippingOptionsOptionReq.md) -- [AdminPostShippingOptionsReq](../classes/internal-26.AdminPostShippingOptionsReq.md) -- [OptionRequirement](../classes/internal-26.OptionRequirement.md) -- [OptionRequirement](../classes/internal-26.OptionRequirement-1.md) - -## Type Aliases - -### AdminShippingOptionsListRes - -Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/index.d.ts:8 - -___ - -### AdminShippingOptionsRes - -Ƭ **AdminShippingOptionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) | - -#### Defined in - -medusa/dist/api/routes/admin/shipping-options/index.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/modules/internal-27.md b/www/apps/docs/content/references/js-client/modules/internal-27.md deleted file mode 100644 index 5afd67c270..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-27.md +++ /dev/null @@ -1,38 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminPostShippingProfilesProfileReq](../classes/internal-27.AdminPostShippingProfilesProfileReq.md) -- [AdminPostShippingProfilesReq](../classes/internal-27.AdminPostShippingProfilesReq.md) - -## Type Aliases - -### AdminShippingProfilesListRes - -Ƭ **AdminShippingProfilesListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12 - -___ - -### AdminShippingProfilesRes - -Ƭ **AdminShippingProfilesRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) | - -#### Defined in - -medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-28.md b/www/apps/docs/content/references/js-client/modules/internal-28.md deleted file mode 100644 index 9b4b21d6f8..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-28.md +++ /dev/null @@ -1,54 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminPostStoreReq](../classes/internal-28.AdminPostStoreReq.md) -- [Store](../classes/internal-28.Store.md) - -## Type Aliases - -### AdminPaymentProvidersList - -Ƭ **AdminPaymentProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/store/index.d.ts:10 - -___ - -### AdminStoresRes - -Ƭ **AdminStoresRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `store` | [`Store`](../classes/internal-28.Store.md) | - -#### Defined in - -medusa/dist/api/routes/admin/store/index.d.ts:4 - -___ - -### AdminTaxProvidersList - -Ƭ **AdminTaxProvidersList**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] | - -#### Defined in - -medusa/dist/api/routes/admin/store/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-29.md b/www/apps/docs/content/references/js-client/modules/internal-29.md deleted file mode 100644 index 96859d3105..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-29.md +++ /dev/null @@ -1,31 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetSwapsParams](../classes/internal-29.AdminGetSwapsParams.md) - -## Type Aliases - -### AdminSwapsListRes - -Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/swaps/index.d.ts:7 - -___ - -### AdminSwapsRes - -Ƭ **AdminSwapsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | - -#### Defined in - -medusa/dist/api/routes/admin/swaps/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/modules/internal-3.md b/www/apps/docs/content/references/js-client/modules/internal-3.md index 9e09aae20b..5795db69c5 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-3.md +++ b/www/apps/docs/content/references/js-client/modules/internal-3.md @@ -1,23 +1,152 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal + +## Enumerations + +- [AllocationType](../enums/internal-3.AllocationType.md) +- [CartType](../enums/internal-3.CartType.md) +- [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md) +- [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md) +- [ClaimReason](../enums/internal-3.ClaimReason.md) +- [ClaimType](../enums/internal-3.ClaimType.md) +- [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md) +- [DiscountConditionType](../enums/internal-3.DiscountConditionType.md) +- [DiscountRuleType](../enums/internal-3.DiscountRuleType.md) +- [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md) +- [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md) +- [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md) +- [OrderEditStatus](../enums/internal-3.OrderEditStatus.md) +- [OrderStatus](../enums/internal-3.OrderStatus.md) +- [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md) +- [PaymentStatus](../enums/internal-3.PaymentStatus.md) +- [PriceListStatus](../enums/internal-3.PriceListStatus.md) +- [PriceListType](../enums/internal-3.PriceListType.md) +- [ProductStatus](../enums/internal-3.ProductStatus.md) +- [RequirementType](../enums/internal-3.RequirementType.md) +- [ReturnStatus](../enums/internal-3.ReturnStatus.md) +- [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md) +- [ShippingProfileType](../enums/internal-3.ShippingProfileType.md) +- [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md) +- [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md) ## Classes +- [Address](../classes/internal-3.Address.md) - [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md) - [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md) - [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md) - [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md) - [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md) - [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md) +- [Cart](../classes/internal-3.Cart.md) +- [ClaimImage](../classes/internal-3.ClaimImage.md) +- [ClaimItem](../classes/internal-3.ClaimItem.md) +- [ClaimOrder](../classes/internal-3.ClaimOrder.md) +- [ClaimTag](../classes/internal-3.ClaimTag.md) +- [Country](../classes/internal-3.Country.md) +- [Currency](../classes/internal-3.Currency.md) +- [Customer](../classes/internal-3.Customer.md) +- [CustomerGroup](../classes/internal-3.CustomerGroup.md) +- [Discount](../classes/internal-3.Discount.md) +- [DiscountCondition](../classes/internal-3.DiscountCondition.md) +- [DiscountRule](../classes/internal-3.DiscountRule.md) +- [DraftOrder](../classes/internal-3.DraftOrder.md) +- [Fulfillment](../classes/internal-3.Fulfillment.md) +- [FulfillmentItem](../classes/internal-3.FulfillmentItem.md) +- [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md) +- [GiftCard](../classes/internal-3.GiftCard.md) +- [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md) +- [Image](../classes/internal-3.Image.md) +- [LineItem](../classes/internal-3.LineItem.md) +- [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md) +- [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md) +- [MoneyAmount](../classes/internal-3.MoneyAmount.md) +- [Order](../classes/internal-3.Order.md) +- [OrderEdit](../classes/internal-3.OrderEdit.md) +- [OrderItemChange](../classes/internal-3.OrderItemChange.md) +- [Payment](../classes/internal-3.Payment.md) +- [PaymentCollection](../classes/internal-3.PaymentCollection.md) +- [PaymentProvider](../classes/internal-3.PaymentProvider.md) +- [PaymentSession](../classes/internal-3.PaymentSession.md) +- [PriceList](../classes/internal-3.PriceList.md) +- [Product](../classes/internal-3.Product.md) +- [ProductCategory](../classes/internal-3.ProductCategory.md) +- [ProductCollection](../classes/internal-3.ProductCollection.md) +- [ProductOption](../classes/internal-3.ProductOption.md) +- [ProductOptionValue](../classes/internal-3.ProductOptionValue.md) +- [ProductTag](../classes/internal-3.ProductTag.md) +- [ProductType](../classes/internal-3.ProductType.md) +- [ProductVariant](../classes/internal-3.ProductVariant.md) +- [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md) +- [Refund](../classes/internal-3.Refund.md) +- [Region](../classes/internal-3.Region.md) +- [Return](../classes/internal-3.Return.md) +- [ReturnItem](../classes/internal-3.ReturnItem.md) +- [ReturnReason](../classes/internal-3.ReturnReason.md) +- [SalesChannel](../classes/internal-3.SalesChannel.md) +- [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md) +- [ShippingMethod](../classes/internal-3.ShippingMethod.md) +- [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md) +- [ShippingOption](../classes/internal-3.ShippingOption.md) +- [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md) +- [ShippingProfile](../classes/internal-3.ShippingProfile.md) +- [Swap](../classes/internal-3.Swap.md) +- [TaxLine](../classes/internal-3.TaxLine.md) +- [TaxProvider](../classes/internal-3.TaxProvider.md) +- [TaxRate](../classes/internal-3.TaxRate.md) +- [TrackingLink](../classes/internal-3.TrackingLink.md) + +## Interfaces + +- [Boolean](../interfaces/internal-3.Boolean.md) + +## Enumeration Members + +### ORDER\_EDIT + +• **ORDER\_EDIT**: ``"order_edit"`` + +#### Defined in + +packages/medusa/dist/models/payment-collection.d.ts:11 ## Type Aliases ### AdminCollectionsListRes -Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } +Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal-3.ProductCollection.md)[] } + +**`Schema`** + +AdminCollectionsListRes +type: object +required: + - collections + - count + - offset + - limit +properties: + collections: + type: array + description: an array of collection details + items: + $ref: "#/components/schemas/ProductCollection" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product collections skipped when retrieving the product collections. + limit: + type: integer + description: The number of items per page #### Defined in -medusa/dist/api/routes/admin/collections/index.d.ts:8 +packages/medusa/dist/api/routes/admin/collections/index.d.ts:32 ___ @@ -25,30 +154,94 @@ ___ Ƭ **AdminCollectionsRes**: `Object` +**`Schema`** + +AdminCollectionsRes +type: object +x-expanded-relations: + field: collection + relations: + - products +required: + - collection +properties: + collection: + type: "Product Collection details." + $ref: "#/components/schemas/ProductCollection" + #### Type declaration | Name | Type | | :------ | :------ | -| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | +| `collection` | [`ProductCollection`](../classes/internal-3.ProductCollection.md) | #### Defined in -medusa/dist/api/routes/admin/collections/index.d.ts:12 +packages/medusa/dist/api/routes/admin/collections/index.d.ts:97 ___ -### DeleteResponse +### AdminDeleteProductsFromCollectionRes -Ƭ **DeleteResponse**: `Object` +Ƭ **AdminDeleteProductsFromCollectionRes**: `Object` + +**`Schema`** + +AdminDeleteProductsFromCollectionRes +type: object +required: + - id + - object + - removed_products +properties: + id: + type: string + description: "The ID of the collection" + object: + type: string + description: "The type of object the removal was executed on" + default: product-collection + removed_products: + description: "The IDs of the products removed from the collection" + type: array + items: + description: "The ID of the Product removed from the Product Collection." + type: string #### Type declaration | Name | Type | | :------ | :------ | -| `deleted` | `boolean` | | `id` | `string` | | `object` | `string` | +| `removed_products` | `string`[] | #### Defined in -medusa/dist/types/common.d.ts:65 +packages/medusa/dist/api/routes/admin/collections/index.d.ts:78 + +## Functions + +### Boolean + +▸ **Boolean**<`T`\>(`value?`): `boolean` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value?` | `T` | + +#### Returns + +`boolean` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:553 diff --git a/www/apps/docs/content/references/js-client/modules/internal-30.md b/www/apps/docs/content/references/js-client/modules/internal-30.md deleted file mode 100644 index 9ac388e0a1..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-30.md +++ /dev/null @@ -1,44 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md) -- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md) -- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md) -- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md) -- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) -- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) -- [AdminGetTaxRatesParams](../classes/internal-30.AdminGetTaxRatesParams.md) -- [AdminGetTaxRatesTaxRateParams](../classes/internal-30.AdminGetTaxRatesTaxRateParams.md) -- [AdminPostTaxRatesReq](../classes/internal-30.AdminPostTaxRatesReq.md) -- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md) -- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md) -- [AdminPostTaxRatesTaxRateReq](../classes/internal-30.AdminPostTaxRatesTaxRateReq.md) -- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md) -- [NumericalComparisonOperator](../classes/internal-30.NumericalComparisonOperator.md) - -## Type Aliases - -### AdminTaxRatesListRes - -Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/index.d.ts:8 - -___ - -### AdminTaxRatesRes - -Ƭ **AdminTaxRatesRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) | - -#### Defined in - -medusa/dist/api/routes/admin/tax-rates/index.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/modules/internal-31.md b/www/apps/docs/content/references/js-client/modules/internal-31.md deleted file mode 100644 index e585946cf7..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-31.md +++ /dev/null @@ -1,39 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminDeleteUploadsReq](../classes/internal-31.AdminDeleteUploadsReq.md) -- [AdminPostUploadsDownloadUrlReq](../classes/internal-31.AdminPostUploadsDownloadUrlReq.md) -- [IAdminPostUploadsFileReq](../classes/internal-31.IAdminPostUploadsFileReq.md) - -## Type Aliases - -### AdminUploadsDownloadUrlRes - -Ƭ **AdminUploadsDownloadUrlRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `download_url` | `string` | - -#### Defined in - -medusa/dist/api/routes/admin/uploads/index.d.ts:10 - -___ - -### AdminUploadsRes - -Ƭ **AdminUploadsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `uploads` | { `url`: `string` }[] | - -#### Defined in - -medusa/dist/api/routes/admin/uploads/index.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/modules/internal-32.md b/www/apps/docs/content/references/js-client/modules/internal-32.md deleted file mode 100644 index 8ff5e8fa1b..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-32.md +++ /dev/null @@ -1,116 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md) -- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md) -- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md) -- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md) - -## Type Aliases - -### AdminCreateUserPayload - -Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) } - -#### Defined in - -[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L31) - -___ - -### AdminUpdateUserPayload - -Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) } - -#### Defined in - -[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L41) - -___ - -### AdminUserRes - -Ƭ **AdminUserRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | - -#### Defined in - -medusa/dist/api/routes/admin/users/index.d.ts:6 - -___ - -### AdminUsersListRes - -Ƭ **AdminUsersListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | - -#### Defined in - -medusa/dist/api/routes/admin/users/index.d.ts:9 - -___ - -### CreateUserRoles - -Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` - -#### Defined in - -[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L28) - -___ - -### CreateUserRolesEnum - -Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\> - -#### Defined in - -[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L25) - -___ - -### NoUndefined - -Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L23) - -___ - -### UpdateUserRoles - -Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` - -#### Defined in - -[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L39) - -___ - -### UpdateUserRolesEnum - -Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\> - -#### Defined in - -[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L37) diff --git a/www/apps/docs/content/references/js-client/modules/internal-33.md b/www/apps/docs/content/references/js-client/modules/internal-33.md deleted file mode 100644 index 9ff582d6e1..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-33.md +++ /dev/null @@ -1,17 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdminGetVariantsParams](../classes/internal-33.AdminGetVariantsParams.md) -- [AdminPriceSelectionParams](../classes/internal-33.AdminPriceSelectionParams.md) -- [PriceSelectionParams](../classes/internal-33.PriceSelectionParams.md) - -## Type Aliases - -### AdminVariantsListRes - -Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] } - -#### Defined in - -medusa/dist/api/routes/admin/variants/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/modules/internal-34.md b/www/apps/docs/content/references/js-client/modules/internal-34.md deleted file mode 100644 index b34e6ba16b..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-34.md +++ /dev/null @@ -1,37 +0,0 @@ -# Namespace: internal - -## Classes - -- [StorePostAuthReq](../classes/internal-34.StorePostAuthReq.md) - -## Type Aliases - -### StoreAuthRes - -Ƭ **StoreAuthRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `customer` | [`Customer`](../classes/internal.Customer.md) | - -#### Defined in - -medusa/dist/api/routes/store/auth/index.d.ts:4 - -___ - -### StoreGetAuthEmailRes - -Ƭ **StoreGetAuthEmailRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `exists` | `boolean` | - -#### Defined in - -medusa/dist/api/routes/store/auth/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-35.md b/www/apps/docs/content/references/js-client/modules/internal-35.md deleted file mode 100644 index 6413505cb0..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-35.md +++ /dev/null @@ -1,38 +0,0 @@ -# Namespace: internal - -## Classes - -- [Discount](../classes/internal-35.Discount.md) -- [GiftCard](../classes/internal-35.GiftCard.md) -- [Item](../classes/internal-35.Item.md) -- [StorePostCartReq](../classes/internal-35.StorePostCartReq.md) -- [StorePostCartsCartPaymentSessionReq](../classes/internal-35.StorePostCartsCartPaymentSessionReq.md) -- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md) -- [StorePostCartsCartReq](../classes/internal-35.StorePostCartsCartReq.md) -- [StorePostCartsCartShippingMethodReq](../classes/internal-35.StorePostCartsCartShippingMethodReq.md) - -## Type Aliases - -### StoreCartsRes - -Ƭ **StoreCartsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | - -#### Defined in - -medusa/dist/api/routes/store/carts/index.d.ts:8 - -___ - -### StoreCompleteCartRes - -Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` } - -#### Defined in - -medusa/dist/api/routes/store/carts/index.d.ts:11 diff --git a/www/apps/docs/content/references/js-client/modules/internal-36.md b/www/apps/docs/content/references/js-client/modules/internal-36.md deleted file mode 100644 index 3c9f7a59da..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-36.md +++ /dev/null @@ -1,31 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetCollectionsParams](../classes/internal-36.StoreGetCollectionsParams.md) - -## Type Aliases - -### StoreCollectionsListRes - -Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/collections/index.d.ts:7 - -___ - -### StoreCollectionsRes - -Ƭ **StoreCollectionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) | - -#### Defined in - -medusa/dist/api/routes/store/collections/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/modules/internal-37.md b/www/apps/docs/content/references/js-client/modules/internal-37.md deleted file mode 100644 index c3b8c108f3..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-37.md +++ /dev/null @@ -1,20 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md) -- [StoreGetCustomersCustomerOrdersParams](../classes/internal-37.StoreGetCustomersCustomerOrdersParams.md) -- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md) -- [StorePostCustomersCustomerReq](../classes/internal-37.StorePostCustomersCustomerReq.md) -- [StorePostCustomersReq](../classes/internal-37.StorePostCustomersReq.md) -- [StorePostCustomersResetPasswordReq](../classes/internal-37.StorePostCustomersResetPasswordReq.md) - -## Type Aliases - -### StoreCustomersListOrdersRes - -Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/customers/index.d.ts:12 diff --git a/www/apps/docs/content/references/js-client/modules/internal-38.md b/www/apps/docs/content/references/js-client/modules/internal-38.md deleted file mode 100644 index 52a8616e22..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-38.md +++ /dev/null @@ -1,17 +0,0 @@ -# Namespace: internal - -## Type Aliases - -### StoreGiftCardsRes - -Ƭ **StoreGiftCardsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | - -#### Defined in - -medusa/dist/api/routes/store/gift-cards/index.d.ts:8 diff --git a/www/apps/docs/content/references/js-client/modules/internal-39.md b/www/apps/docs/content/references/js-client/modules/internal-39.md deleted file mode 100644 index 01a07e9994..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-39.md +++ /dev/null @@ -1,6 +0,0 @@ -# Namespace: internal - -## Classes - -- [StorePostCartsCartLineItemsItemReq](../classes/internal-39.StorePostCartsCartLineItemsItemReq.md) -- [StorePostCartsCartLineItemsReq](../classes/internal-39.StorePostCartsCartLineItemsReq.md) diff --git a/www/apps/docs/content/references/js-client/modules/internal-4.md b/www/apps/docs/content/references/js-client/modules/internal-4.md index 2742c7ffdd..105f8a1a3f 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-4.md +++ b/www/apps/docs/content/references/js-client/modules/internal-4.md @@ -1,4 +1,8 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal ## Classes @@ -10,11 +14,36 @@ ### AdminCurrenciesListRes -Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal.Currency.md)[] } +Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal-3.Currency.md)[] } + +**`Schema`** + +AdminCurrenciesListRes +type: object +required: + - currencies + - count + - offset + - limit +properties: + currencies: + type: array + description: An array of currency details. + items: + $ref: "#/components/schemas/Currency" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of currencies skipped when retrieving the currencies. + limit: + type: integer + description: The number of items per page #### Defined in -medusa/dist/api/routes/admin/currencies/index.d.ts:5 +packages/medusa/dist/api/routes/admin/currencies/index.d.ts:29 ___ @@ -22,12 +51,23 @@ ___ Ƭ **AdminCurrenciesRes**: `Object` +**`Schema`** + +AdminCurrenciesRes +type: object +required: + - currency +properties: + currency: + description: Currency details. + $ref: "#/components/schemas/Currency" + #### Type declaration | Name | Type | | :------ | :------ | -| `currency` | [`Currency`](../classes/internal.Currency.md) | +| `currency` | [`Currency`](../classes/internal-3.Currency.md) | #### Defined in -medusa/dist/api/routes/admin/currencies/index.d.ts:8 +packages/medusa/dist/api/routes/admin/currencies/index.d.ts:42 diff --git a/www/apps/docs/content/references/js-client/modules/internal-40.md b/www/apps/docs/content/references/js-client/modules/internal-40.md deleted file mode 100644 index 2254f2ed1c..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-40.md +++ /dev/null @@ -1,21 +0,0 @@ -# Namespace: internal - -## Classes - -- [StorePostOrderEditsOrderEditDecline](../classes/internal-40.StorePostOrderEditsOrderEditDecline.md) - -## Type Aliases - -### StoreOrderEditsRes - -Ƭ **StoreOrderEditsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | - -#### Defined in - -medusa/dist/api/routes/store/order-edits/index.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/modules/internal-41.md b/www/apps/docs/content/references/js-client/modules/internal-41.md deleted file mode 100644 index 639b9ac1bb..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-41.md +++ /dev/null @@ -1,24 +0,0 @@ -# Namespace: internal - -## Classes - -- [ShippingAddressPayload](../classes/internal-41.ShippingAddressPayload.md) -- [StoreGetOrdersParams](../classes/internal-41.StoreGetOrdersParams.md) -- [StorePostCustomersCustomerAcceptClaimReq](../classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md) -- [StorePostCustomersCustomerOrderClaimReq](../classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md) - -## Type Aliases - -### StoreOrdersRes - -Ƭ **StoreOrdersRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | - -#### Defined in - -medusa/dist/api/routes/store/orders/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-42.md b/www/apps/docs/content/references/js-client/modules/internal-42.md deleted file mode 100644 index dcdac48a4f..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-42.md +++ /dev/null @@ -1,40 +0,0 @@ -# Namespace: internal - -## Classes - -- [StorePaymentCollectionSessionsReq](../classes/internal-42.StorePaymentCollectionSessionsReq.md) -- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) -- [StorePostPaymentCollectionsBatchSessionsReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md) -- [StorePostPaymentCollectionsSessionsReq](../classes/internal-42.StorePostPaymentCollectionsSessionsReq.md) - -## Type Aliases - -### StorePaymentCollectionsRes - -Ƭ **StorePaymentCollectionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) | - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/index.d.ts:7 - -___ - -### StorePaymentCollectionsSessionRes - -Ƭ **StorePaymentCollectionsSessionRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_session` | [`PaymentSession`](../classes/internal.PaymentSession.md) | - -#### Defined in - -medusa/dist/api/routes/store/payment-collections/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/modules/internal-43.md b/www/apps/docs/content/references/js-client/modules/internal-43.md deleted file mode 100644 index 4c6cd3245f..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-43.md +++ /dev/null @@ -1,17 +0,0 @@ -# Namespace: internal - -## Type Aliases - -### StoreCustomersListPaymentMethodsRes - -Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | - -#### Defined in - -medusa/dist/api/routes/store/customers/index.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/modules/internal-44.md b/www/apps/docs/content/references/js-client/modules/internal-44.md deleted file mode 100644 index fdc80dc807..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-44.md +++ /dev/null @@ -1,15 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetProductTypesParams](../classes/internal-44.StoreGetProductTypesParams.md) - -## Type Aliases - -### StoreProductTypesListRes - -Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/product-types/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-45.md b/www/apps/docs/content/references/js-client/modules/internal-45.md deleted file mode 100644 index e5dff6c50a..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-45.md +++ /dev/null @@ -1,31 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetVariantsParams](../classes/internal-45.StoreGetVariantsParams.md) - -## Type Aliases - -### StoreVariantsListRes - -Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/variants/index.d.ts:9 - -___ - -### StoreVariantsRes - -Ƭ **StoreVariantsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) | - -#### Defined in - -medusa/dist/api/routes/store/variants/index.d.ts:6 diff --git a/www/apps/docs/content/references/js-client/modules/internal-46.md b/www/apps/docs/content/references/js-client/modules/internal-46.md deleted file mode 100644 index 678e368f12..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-46.md +++ /dev/null @@ -1,53 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetProductsPaginationParams](../classes/internal-46.StoreGetProductsPaginationParams.md) -- [StoreGetProductsParams](../classes/internal-46.StoreGetProductsParams.md) -- [StorePostSearchReq](../classes/internal-46.StorePostSearchReq.md) - -## Type Aliases - -### StorePostSearchRes - -Ƭ **StorePostSearchRes**: `Object` - -#### Index signature - -▪ [k: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `hits` | `unknown`[] | - -#### Defined in - -medusa/dist/api/routes/store/products/index.d.ts:13 - -___ - -### StoreProductsListRes - -Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] } - -#### Defined in - -medusa/dist/api/routes/store/products/index.d.ts:17 - -___ - -### StoreProductsRes - -Ƭ **StoreProductsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `product` | [`Product`](../classes/internal.Product.md) | - -#### Defined in - -medusa/dist/api/routes/store/products/index.d.ts:10 diff --git a/www/apps/docs/content/references/js-client/modules/internal-47.md b/www/apps/docs/content/references/js-client/modules/internal-47.md deleted file mode 100644 index 1235343f30..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-47.md +++ /dev/null @@ -1,33 +0,0 @@ -# Namespace: internal - -## Type Aliases - -### StoreRegionsListRes - -Ƭ **StoreRegionsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `regions` | [`Region`](../classes/internal.Region.md)[] | - -#### Defined in - -medusa/dist/api/routes/store/regions/index.d.ts:4 - -___ - -### StoreRegionsRes - -Ƭ **StoreRegionsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `region` | [`Region`](../classes/internal.Region.md) | - -#### Defined in - -medusa/dist/api/routes/store/regions/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-48.md b/www/apps/docs/content/references/js-client/modules/internal-48.md deleted file mode 100644 index 20dac0fd61..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-48.md +++ /dev/null @@ -1,33 +0,0 @@ -# Namespace: internal - -## Type Aliases - -### StoreReturnReasonsListRes - -Ƭ **StoreReturnReasonsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] | - -#### Defined in - -medusa/dist/api/routes/store/return-reasons/index.d.ts:6 - -___ - -### StoreReturnReasonsRes - -Ƭ **StoreReturnReasonsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) | - -#### Defined in - -medusa/dist/api/routes/store/return-reasons/index.d.ts:9 diff --git a/www/apps/docs/content/references/js-client/modules/internal-49.md b/www/apps/docs/content/references/js-client/modules/internal-49.md deleted file mode 100644 index d19bea89e1..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-49.md +++ /dev/null @@ -1,23 +0,0 @@ -# Namespace: internal - -## Classes - -- [Item](../classes/internal-49.Item.md) -- [ReturnShipping](../classes/internal-49.ReturnShipping.md) -- [StorePostReturnsReq](../classes/internal-49.StorePostReturnsReq.md) - -## Type Aliases - -### StoreReturnsRes - -Ƭ **StoreReturnsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `return` | [`Return`](../classes/internal.Return.md) | - -#### Defined in - -medusa/dist/api/routes/store/returns/index.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/modules/internal-5.md b/www/apps/docs/content/references/js-client/modules/internal-5.md index 0252dcab05..e5ce3e44ec 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-5.md +++ b/www/apps/docs/content/references/js-client/modules/internal-5.md @@ -1,52 +1,9 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- -## Classes +# Module: internal -- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) -- [AdminGetCustomerGroupsGroupParams](../classes/internal-5.AdminGetCustomerGroupsGroupParams.md) -- [AdminGetCustomerGroupsParams](../classes/internal-5.AdminGetCustomerGroupsParams.md) -- [AdminGetCustomersParams](../classes/internal-5.AdminGetCustomersParams.md) -- [AdminListCustomerSelector](../classes/internal-5.AdminListCustomerSelector.md) -- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md) -- [AdminPostCustomerGroupsGroupReq](../classes/internal-5.AdminPostCustomerGroupsGroupReq.md) -- [AdminPostCustomerGroupsReq](../classes/internal-5.AdminPostCustomerGroupsReq.md) -- [CustomerGroupsBatchCustomer](../classes/internal-5.CustomerGroupsBatchCustomer.md) -- [FilterableCustomerGroupProps](../classes/internal-5.FilterableCustomerGroupProps.md) -- [FindParams](../classes/internal-5.FindParams.md) -- [StringComparisonOperator](../classes/internal-5.StringComparisonOperator.md) +## Interfaces -## Type Aliases - -### AdminCustomerGroupsListRes - -Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/index.d.ts:9 - -___ - -### AdminCustomerGroupsRes - -Ƭ **AdminCustomerGroupsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) | - -#### Defined in - -medusa/dist/api/routes/admin/customer-groups/index.d.ts:5 - -___ - -### AdminCustomersListRes - -Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/customers/index.d.ts:9 +- [RequestOptions](../interfaces/internal-5.RequestOptions.md) diff --git a/www/apps/docs/content/references/js-client/modules/internal-50.md b/www/apps/docs/content/references/js-client/modules/internal-50.md deleted file mode 100644 index c56c68a595..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-50.md +++ /dev/null @@ -1,21 +0,0 @@ -# Namespace: internal - -## Classes - -- [StoreGetShippingOptionsParams](../classes/internal-50.StoreGetShippingOptionsParams.md) - -## Type Aliases - -### StoreShippingOptionsListRes - -Ƭ **StoreShippingOptionsListRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] | - -#### Defined in - -medusa/dist/api/routes/store/shipping-options/index.d.ts:4 diff --git a/www/apps/docs/content/references/js-client/modules/internal-51.md b/www/apps/docs/content/references/js-client/modules/internal-51.md deleted file mode 100644 index 939d069c35..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-51.md +++ /dev/null @@ -1,23 +0,0 @@ -# Namespace: internal - -## Classes - -- [AdditionalItem](../classes/internal-51.AdditionalItem.md) -- [Item](../classes/internal-51.Item.md) -- [StorePostSwapsReq](../classes/internal-51.StorePostSwapsReq.md) - -## Type Aliases - -### StoreSwapsRes - -Ƭ **StoreSwapsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `swap` | [`Swap`](../classes/internal.Swap.md) | - -#### Defined in - -medusa/dist/api/routes/store/swaps/index.d.ts:7 diff --git a/www/apps/docs/content/references/js-client/modules/internal-6.md b/www/apps/docs/content/references/js-client/modules/internal-6.md index 81b81169fc..8d8cf2115b 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-6.md +++ b/www/apps/docs/content/references/js-client/modules/internal-6.md @@ -1,23 +1,80 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal ## Classes -- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md) -- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md) -- [Group](../classes/internal-6.Group.md) +- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) +- [AdminGetCustomerGroupsGroupParams](../classes/internal-6.AdminGetCustomerGroupsGroupParams.md) +- [AdminGetCustomerGroupsParams](../classes/internal-6.AdminGetCustomerGroupsParams.md) +- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) +- [AdminPostCustomerGroupsGroupReq](../classes/internal-6.AdminPostCustomerGroupsGroupReq.md) +- [AdminPostCustomerGroupsReq](../classes/internal-6.AdminPostCustomerGroupsReq.md) +- [CustomerGroupsBatchCustomer](../classes/internal-6.CustomerGroupsBatchCustomer.md) +- [FilterableCustomerGroupProps](../classes/internal-6.FilterableCustomerGroupProps.md) +- [FindParams](../classes/internal-6.FindParams.md) +- [StringComparisonOperator](../classes/internal-6.StringComparisonOperator.md) ## Type Aliases -### AdminCustomersRes +### AdminCustomerGroupsListRes -Ƭ **AdminCustomersRes**: `Object` +Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal-3.CustomerGroup.md)[] } + +**`Schema`** + +AdminCustomerGroupsListRes +type: object +required: + - customer_groups + - count + - offset + - limit +properties: + customer_groups: + type: array + description: An array of customer group details. + items: + $ref: "#/components/schemas/CustomerGroup" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of customer groups skipped when retrieving the customer groups. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:63 + +___ + +### AdminCustomerGroupsRes + +Ƭ **AdminCustomerGroupsRes**: `Object` + +**`Schema`** + +AdminCustomerGroupsRes +type: object +required: + - customer_group +properties: + customer_group: + description: Customer group details. + $ref: "#/components/schemas/CustomerGroup" #### Type declaration | Name | Type | | :------ | :------ | -| `customer` | [`Customer`](../classes/internal.Customer.md) | +| `customer_group` | [`CustomerGroup`](../classes/internal-3.CustomerGroup.md) | #### Defined in -medusa/dist/api/routes/admin/customers/index.d.ts:5 +packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:15 diff --git a/www/apps/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md b/www/apps/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md deleted file mode 100644 index 59e0ec779a..0000000000 --- a/www/apps/docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md +++ /dev/null @@ -1,123 +0,0 @@ -# Namespace: "/home/runner/work/medusa/medusa/packages/medusa/dist/types/global" - -[internal](internal-7.md)."/home/runner/work/medusa/medusa/packages/medusa/dist/types/global" - -## Type Aliases - -### ClassConstructor - -Ƭ **ClassConstructor**<`T`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -medusa/dist/types/global.d.ts:27 - -___ - -### ConfigModule - -Ƭ **ConfigModule**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `featureFlags` | `Record`<`string`, `boolean` \| `string`\> | -| `moduleResolutions?` | `Record`<`string`, [`ModuleResolution`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduleresolution)\> | -| `modules?` | `Record`<`string`, `string`\> | -| `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] | -| `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } | -| `projectConfig.admin_cors?` | `string` | -| `projectConfig.cookie_secret?` | `string` | -| `projectConfig.database_database?` | `string` | -| `projectConfig.database_extra?` | `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } | -| `projectConfig.database_logging` | `LoggerOptions` | -| `projectConfig.database_type` | `string` | -| `projectConfig.database_url?` | `string` | -| `projectConfig.jwt_secret?` | `string` | -| `projectConfig.redis_url?` | `string` | -| `projectConfig.store_cors?` | `string` | - -#### Defined in - -medusa/dist/types/global.d.ts:50 - -___ - -### ExtendedRequest - -Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } - -#### Type parameters - -| Name | -| :------ | -| `TEntity` | - -#### Defined in - -medusa/dist/types/global.d.ts:24 - -___ - -### Logger - -Ƭ **Logger**: `_Logger` & { `info`: (`msg`: `string`) => `void` ; `progress`: (`activityId`: `string`, `msg`: `string`) => `void` ; `warn`: (`msg`: `string`) => `void` } - -#### Defined in - -medusa/dist/types/global.d.ts:33 - -___ - -### MedusaContainer - -Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#medusacontainer) } - -#### Defined in - -medusa/dist/types/global.d.ts:30 - -___ - -### ModuleDefinition - -Ƭ **ModuleDefinition**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `canOverride?` | `boolean` | -| `defaultPackage` | `string` | -| `isRequired?` | `boolean` | -| `key` | `string` | -| `label` | `string` | -| `registrationName` | `string` | - -#### Defined in - -medusa/dist/types/global.d.ts:42 - -___ - -### ModuleResolution - -Ƭ **ModuleResolution**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `definition` | [`ModuleDefinition`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduledefinition) | -| `resolutionPath` | `string` | - -#### Defined in - -medusa/dist/types/global.d.ts:38 diff --git a/www/apps/docs/content/references/js-client/modules/internal-7.md b/www/apps/docs/content/references/js-client/modules/internal-7.md index a53e14644e..877d155b60 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-7.md +++ b/www/apps/docs/content/references/js-client/modules/internal-7.md @@ -1,78 +1,80 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- -## Namespaces - -- ["/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) +# Module: internal ## Classes -- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.md) -- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) -- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md) -- [AdminGetDiscountsDiscountRuleParams](../classes/internal-7.AdminGetDiscountsDiscountRuleParams.md) -- [AdminGetDiscountsParams](../classes/internal-7.AdminGetDiscountsParams.md) -- [AdminPostDiscountsDiscountConditions](../classes/internal-7.AdminPostDiscountsDiscountConditions.md) -- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md) -- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) -- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) -- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md) -- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md) -- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md) -- [AdminPostDiscountsDiscountReq](../classes/internal-7.AdminPostDiscountsDiscountReq.md) -- [AdminPostDiscountsDiscountRule](../classes/internal-7.AdminPostDiscountsDiscountRule.md) -- [AdminPostDiscountsReq](../classes/internal-7.AdminPostDiscountsReq.md) -- [AdminUpdateDiscountRule](../classes/internal-7.AdminUpdateDiscountRule.md) -- [AdminUpsertCondition](../classes/internal-7.AdminUpsertCondition.md) -- [AdminUpsertConditionsReq](../classes/internal-7.AdminUpsertConditionsReq.md) +- [AdminGetCustomersParams](../classes/internal-7.AdminGetCustomersParams.md) +- [AdminListCustomerSelector](../classes/internal-7.AdminListCustomerSelector.md) +- [AdminPostCustomersCustomerReq](../classes/internal-7.AdminPostCustomersCustomerReq.md) +- [AdminPostCustomersReq](../classes/internal-7.AdminPostCustomersReq.md) +- [Group](../classes/internal-7.Group.md) ## Type Aliases -### AdminDiscountConditionsRes +### AdminCustomersListRes -Ƭ **AdminDiscountConditionsRes**: `Object` +Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal-3.Customer.md)[] } + +**`Schema`** + +AdminCustomersListRes +type: object +required: + - customers + - count + - offset + - limit +properties: + customers: + type: array + description: "An array of customer details." + items: + $ref: "#/components/schemas/Customer" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of customers skipped when retrieving the customers. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/index.d.ts:47 + +___ + +### AdminCustomersRes + +Ƭ **AdminCustomersRes**: `Object` + +**`Schema`** + +AdminCustomersRes +type: object +x-expanded-relations: + field: customer + relations: + - orders + - shipping_addresses +required: + - customer +properties: + customer: + description: "Customer details." + $ref: "#/components/schemas/Customer" #### Type declaration | Name | Type | | :------ | :------ | -| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) | +| `customer` | [`Customer`](../classes/internal-3.Customer.md) | #### Defined in -medusa/dist/api/routes/admin/discounts/index.d.ts:14 - -___ - -### AdminDiscountsListRes - -Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/discounts/index.d.ts:18 - -___ - -### AdminDiscountsRes - -Ƭ **AdminDiscountsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `discount` | [`Discount`](../classes/internal.Discount.md) | - -#### Defined in - -medusa/dist/api/routes/admin/discounts/index.d.ts:11 - -## Variables - -### AdminGetDiscountsParams\_base - -• `Const` **AdminGetDiscountsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md) - -#### Defined in - -medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:87 +packages/medusa/dist/api/routes/admin/customers/index.d.ts:20 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md b/www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md new file mode 100644 index 0000000000..34660f1776 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.EventEmitter.md @@ -0,0 +1,17 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: EventEmitter + +[internal](internal-8.md).EventEmitter + +## Interfaces + +- [Abortable](../interfaces/internal-8.EventEmitter.Abortable.md) + +## References + +### EventEmitter + +Re-exports [EventEmitter](../classes/internal-8.EventEmitter-1.md) diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md new file mode 100644 index 0000000000..d63551bad2 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-1.md @@ -0,0 +1,643 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +[internal](internal-8.md).internal + +## References + +### Address + +Re-exports [Address](../classes/internal-3.Address.md) + +___ + +### AllocationType + +Re-exports [AllocationType](../enums/internal-3.AllocationType.md) + +___ + +### AnalyticsConfig + +Re-exports [AnalyticsConfig](../classes/internal-8.internal.AnalyticsConfig.md) + +___ + +### BatchJob + +Re-exports [BatchJob](../classes/internal-2.BatchJob.md) + +___ + +### Cart + +Re-exports [Cart](../classes/internal-3.Cart.md) + +___ + +### CartType + +Re-exports [CartType](../enums/internal-3.CartType.md) + +___ + +### ClaimFulfillmentStatus + +Re-exports [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md) + +___ + +### ClaimImage + +Re-exports [ClaimImage](../classes/internal-3.ClaimImage.md) + +___ + +### ClaimItem + +Re-exports [ClaimItem](../classes/internal-3.ClaimItem.md) + +___ + +### ClaimOrder + +Re-exports [ClaimOrder](../classes/internal-3.ClaimOrder.md) + +___ + +### ClaimPaymentStatus + +Re-exports [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md) + +___ + +### ClaimReason + +Re-exports [ClaimReason](../enums/internal-3.ClaimReason.md) + +___ + +### ClaimTag + +Re-exports [ClaimTag](../classes/internal-3.ClaimTag.md) + +___ + +### ClaimType + +Re-exports [ClaimType](../enums/internal-3.ClaimType.md) + +___ + +### Country + +Re-exports [Country](../classes/internal-3.Country.md) + +___ + +### Currency + +Re-exports [Currency](../classes/internal-3.Currency.md) + +___ + +### CustomShippingOption + +Re-exports [CustomShippingOption](../classes/internal-8.internal.CustomShippingOption.md) + +___ + +### Customer + +Re-exports [Customer](../classes/internal-3.Customer.md) + +___ + +### CustomerGroup + +Re-exports [CustomerGroup](../classes/internal-3.CustomerGroup.md) + +___ + +### Discount + +Re-exports [Discount](../classes/internal-3.Discount.md) + +___ + +### DiscountCondition + +Re-exports [DiscountCondition](../classes/internal-3.DiscountCondition.md) + +___ + +### DiscountConditionCustomerGroup + +Re-exports [DiscountConditionCustomerGroup](../classes/internal-8.internal.DiscountConditionCustomerGroup.md) + +___ + +### DiscountConditionOperator + +Re-exports [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md) + +___ + +### DiscountConditionProduct + +Re-exports [DiscountConditionProduct](../classes/internal-8.internal.DiscountConditionProduct.md) + +___ + +### DiscountConditionProductCollection + +Re-exports [DiscountConditionProductCollection](../classes/internal-8.internal.DiscountConditionProductCollection.md) + +___ + +### DiscountConditionProductTag + +Re-exports [DiscountConditionProductTag](../classes/internal-8.internal.DiscountConditionProductTag.md) + +___ + +### DiscountConditionProductType + +Re-exports [DiscountConditionProductType](../classes/internal-8.internal.DiscountConditionProductType.md) + +___ + +### DiscountConditionType + +Re-exports [DiscountConditionType](../enums/internal-3.DiscountConditionType.md) + +___ + +### DiscountRule + +Re-exports [DiscountRule](../classes/internal-3.DiscountRule.md) + +___ + +### DiscountRuleType + +Re-exports [DiscountRuleType](../enums/internal-3.DiscountRuleType.md) + +___ + +### DraftOrder + +Re-exports [DraftOrder](../classes/internal-3.DraftOrder.md) + +___ + +### DraftOrderStatus + +Re-exports [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md) + +___ + +### Fulfillment + +Re-exports [Fulfillment](../classes/internal-3.Fulfillment.md) + +___ + +### FulfillmentItem + +Re-exports [FulfillmentItem](../classes/internal-3.FulfillmentItem.md) + +___ + +### FulfillmentProvider + +Re-exports [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md) + +___ + +### FulfillmentStatus + +Re-exports [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md) + +___ + +### GiftCard + +Re-exports [GiftCard](../classes/internal-3.GiftCard.md) + +___ + +### GiftCardTransaction + +Re-exports [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md) + +___ + +### IdempotencyKey + +Re-exports [IdempotencyKey](../classes/internal-8.internal.IdempotencyKey.md) + +___ + +### Image + +Re-exports [Image](../classes/internal-3.Image.md) + +___ + +### Invite + +Re-exports [Invite](../classes/internal-8.internal.Invite.md) + +___ + +### LineItem + +Re-exports [LineItem](../classes/internal-3.LineItem.md) + +___ + +### LineItemAdjustment + +Re-exports [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md) + +___ + +### LineItemTaxLine + +Re-exports [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md) + +___ + +### MoneyAmount + +Re-exports [MoneyAmount](../classes/internal-3.MoneyAmount.md) + +___ + +### Note + +Re-exports [Note](../classes/internal-8.internal.Note.md) + +___ + +### Notification + +Re-exports [Notification](../classes/internal-8.internal.Notification.md) + +___ + +### Oauth + +Re-exports [Oauth](../classes/internal-8.internal.Oauth.md) + +___ + +### Order + +Re-exports [Order](../classes/internal-3.Order.md) + +___ + +### OrderEdit + +Re-exports [OrderEdit](../classes/internal-3.OrderEdit.md) + +___ + +### OrderEditItemChangeType + +Re-exports [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md) + +___ + +### OrderEditStatus + +Re-exports [OrderEditStatus](../enums/internal-3.OrderEditStatus.md) + +___ + +### OrderItemChange + +Re-exports [OrderItemChange](../classes/internal-3.OrderItemChange.md) + +___ + +### OrderStatus + +Re-exports [OrderStatus](../enums/internal-3.OrderStatus.md) + +___ + +### Payment + +Re-exports [Payment](../classes/internal-3.Payment.md) + +___ + +### PaymentCollection + +Re-exports [PaymentCollection](../classes/internal-3.PaymentCollection.md) + +___ + +### PaymentCollectionStatus + +Re-exports [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md) + +___ + +### PaymentCollectionType + +Re-exports [PaymentCollectionType](../enums/internal-8.internal.PaymentCollectionType.md) + +___ + +### PaymentProvider + +Re-exports [PaymentProvider](../classes/internal-3.PaymentProvider.md) + +___ + +### PaymentSession + +Re-exports [PaymentSession](../classes/internal-3.PaymentSession.md) + +___ + +### PaymentSessionStatus + +Re-exports [PaymentSessionStatus](../enums/internal-8.internal.PaymentSessionStatus.md) + +___ + +### PaymentStatus + +Re-exports [PaymentStatus](../enums/internal-3.PaymentStatus.md) + +___ + +### PriceList + +Re-exports [PriceList](../classes/internal-3.PriceList.md) + +___ + +### Product + +Re-exports [Product](../classes/internal-3.Product.md) + +___ + +### ProductCategory + +Re-exports [ProductCategory](../classes/internal-3.ProductCategory.md) + +___ + +### ProductCollection + +Re-exports [ProductCollection](../classes/internal-3.ProductCollection.md) + +___ + +### ProductOption + +Re-exports [ProductOption](../classes/internal-3.ProductOption.md) + +___ + +### ProductOptionValue + +Re-exports [ProductOptionValue](../classes/internal-3.ProductOptionValue.md) + +___ + +### ProductStatus + +Re-exports [ProductStatus](../enums/internal-3.ProductStatus.md) + +___ + +### ProductTag + +Re-exports [ProductTag](../classes/internal-3.ProductTag.md) + +___ + +### ProductTaxRate + +Re-exports [ProductTaxRate](../classes/internal-8.internal.ProductTaxRate.md) + +___ + +### ProductType + +Re-exports [ProductType](../classes/internal-3.ProductType.md) + +___ + +### ProductTypeTaxRate + +Re-exports [ProductTypeTaxRate](../classes/internal-8.internal.ProductTypeTaxRate.md) + +___ + +### ProductVariant + +Re-exports [ProductVariant](../classes/internal-3.ProductVariant.md) + +___ + +### ProductVariantInventoryItem + +Re-exports [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md) + +___ + +### ProductVariantMoneyAmount + +Re-exports [ProductVariantMoneyAmount](../classes/internal-8.internal.ProductVariantMoneyAmount.md) + +___ + +### PublishableApiKey + +Re-exports [PublishableApiKey](../classes/internal-8.internal.PublishableApiKey.md) + +___ + +### PublishableApiKeySalesChannel + +Re-exports [PublishableApiKeySalesChannel](../classes/internal-8.internal.PublishableApiKeySalesChannel.md) + +___ + +### Refund + +Re-exports [Refund](../classes/internal-3.Refund.md) + +___ + +### RefundReason + +Re-exports [RefundReason](../enums/internal-8.internal.RefundReason.md) + +___ + +### Region + +Re-exports [Region](../classes/internal-3.Region.md) + +___ + +### RequirementType + +Re-exports [RequirementType](../enums/internal-3.RequirementType.md) + +___ + +### Return + +Re-exports [Return](../classes/internal-3.Return.md) + +___ + +### ReturnItem + +Re-exports [ReturnItem](../classes/internal-3.ReturnItem.md) + +___ + +### ReturnReason + +Re-exports [ReturnReason](../classes/internal-3.ReturnReason.md) + +___ + +### ReturnStatus + +Re-exports [ReturnStatus](../enums/internal-3.ReturnStatus.md) + +___ + +### SalesChannel + +Re-exports [SalesChannel](../classes/internal-3.SalesChannel.md) + +___ + +### SalesChannelLocation + +Re-exports [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md) + +___ + +### ShippingMethod + +Re-exports [ShippingMethod](../classes/internal-3.ShippingMethod.md) + +___ + +### ShippingMethodTaxLine + +Re-exports [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md) + +___ + +### ShippingOption + +Re-exports [ShippingOption](../classes/internal-3.ShippingOption.md) + +___ + +### ShippingOptionPriceType + +Re-exports [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md) + +___ + +### ShippingOptionRequirement + +Re-exports [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md) + +___ + +### ShippingProfile + +Re-exports [ShippingProfile](../classes/internal-3.ShippingProfile.md) + +___ + +### ShippingProfileType + +Re-exports [ShippingProfileType](../enums/internal-3.ShippingProfileType.md) + +___ + +### ShippingTaxRate + +Re-exports [ShippingTaxRate](../classes/internal-8.internal.ShippingTaxRate.md) + +___ + +### StagedJob + +Re-exports [StagedJob](../classes/internal-8.internal.StagedJob.md) + +___ + +### Store + +Re-exports [Store](../classes/internal-8.internal.Store.md) + +___ + +### Swap + +Re-exports [Swap](../classes/internal-3.Swap.md) + +___ + +### SwapFulfillmentStatus + +Re-exports [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md) + +___ + +### SwapPaymentStatus + +Re-exports [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md) + +___ + +### TaxProvider + +Re-exports [TaxProvider](../classes/internal-3.TaxProvider.md) + +___ + +### TaxRate + +Re-exports [TaxRate](../classes/internal-3.TaxRate.md) + +___ + +### TrackingLink + +Re-exports [TrackingLink](../classes/internal-3.TrackingLink.md) + +___ + +### User + +Re-exports [User](../classes/internal-1.User.md) + +___ + +### UserRoles + +Re-exports [UserRoles](../enums/internal-1.UserRoles.md) diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md new file mode 100644 index 0000000000..6ea03b24f0 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.finished.md @@ -0,0 +1,28 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: finished + +[internal](internal-8.md).[internal](internal-8.internal-2.md).finished + +## Functions + +### \_\_promisify\_\_ + +▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `options?` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1230 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md new file mode 100644 index 0000000000..bd28198e97 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.md @@ -0,0 +1,835 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +[internal](internal-8.md).internal + +## Namespaces + +- [finished](internal-8.internal-2.finished.md) +- [pipeline](internal-8.internal-2.pipeline.md) + +## Classes + +- [Writable](../classes/internal-8.internal-2.Writable.md) + +## Interfaces + +- [FinishedOptions](../interfaces/internal-8.internal-2.FinishedOptions.md) +- [Pipe](../interfaces/internal-8.internal-2.Pipe.md) +- [PipelineOptions](../interfaces/internal-8.internal-2.PipelineOptions.md) +- [ReadableOptions](../interfaces/internal-8.internal-2.ReadableOptions.md) +- [StreamOptions](../interfaces/internal-8.internal-2.StreamOptions.md) +- [WritableOptions](../interfaces/internal-8.internal-2.WritableOptions.md) + +## References + +### Duplex + +Re-exports [Duplex](../classes/internal-8.Duplex.md) + +___ + +### DuplexOptions + +Re-exports [DuplexOptions](../interfaces/internal-8.DuplexOptions.md) + +___ + +### PassThrough + +Re-exports [PassThrough](../classes/internal-8.PassThrough.md) + +___ + +### Readable + +Re-exports [Readable](../classes/internal-8.Readable.md) + +___ + +### Stream + +Re-exports [Stream](../classes/internal-8.Stream.md) + +___ + +### Transform + +Re-exports [Transform](../classes/internal-8.Transform.md) + +___ + +### TransformCallback + +Re-exports [TransformCallback](internal-8.md#transformcallback) + +___ + +### TransformOptions + +Re-exports [TransformOptions](../interfaces/internal-8.TransformOptions.md) + +## Type Aliases + +### PipelineCallback + +Ƭ **PipelineCallback**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, infer P\> ? (`err`: [`ErrnoException`](../interfaces/internal-8.ErrnoException.md) \| ``null``, `value`: `P`) => `void` : (`err`: [`ErrnoException`](../interfaces/internal-8.ErrnoException.md) \| ``null``) => `void` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`PipelineDestination`](internal-8.internal-2.md#pipelinedestination)<`any`, `any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1243 + +___ + +### PipelineDestination + +Ƭ **PipelineDestination**<`S`, `P`\>: `S` extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource) ? [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`ST`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`ST`, `P`\> : `never` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource)<`any`\> | +| `P` | `P` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1240 + +___ + +### PipelineDestinationIterableFunction + +Ƭ **PipelineDestinationIterableFunction**<`T`\>: (`source`: [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>) => [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (`source`): [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> | + +##### Returns + +[`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`any`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1238 + +___ + +### PipelineDestinationPromiseFunction + +Ƭ **PipelineDestinationPromiseFunction**<`T`, `P`\>: (`source`: [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\>) => `Promise`<`P`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | +| `P` | + +#### Type declaration + +▸ (`source`): `Promise`<`P`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> | + +##### Returns + +`Promise`<`P`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1239 + +___ + +### PipelinePromise + +Ƭ **PipelinePromise**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, infer P\> ? `Promise`<`P`\> : `Promise`<`void`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`PipelineDestination`](internal-8.internal-2.md#pipelinedestination)<`any`, `any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1246 + +___ + +### PipelineSource + +Ƭ **PipelineSource**<`T`\>: [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> \| [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`PipelineSourceFunction`](internal-8.internal-2.md#pipelinesourcefunction)<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1233 + +___ + +### PipelineSourceFunction + +Ƭ **PipelineSourceFunction**<`T`\>: () => [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +▸ (): [`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> + +##### Returns + +[`Iterable`](../interfaces/internal-8.Iterable.md)<`T`\> \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`T`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1232 + +___ + +### PipelineTransform + +Ƭ **PipelineTransform**<`S`, `U`\>: [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| (`source`: `S` extends (...`args`: `any`[]) => [`Iterable`](../interfaces/internal-8.Iterable.md) \| [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md) ? [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`ST`\> : `S`) => [`AsyncIterable`](../interfaces/internal-8.AsyncIterable.md)<`U`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`PipelineTransformSource`](internal-8.internal-2.md#pipelinetransformsource)<`any`\> | +| `U` | `U` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1234 + +___ + +### PipelineTransformSource + +Ƭ **PipelineTransformSource**<`T`\>: [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`T`\> \| [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`any`, `T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1237 + +## Variables + +### consumers + +• `Const` **consumers**: typeof [`internal`](internal-8.internal-4.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1414 + +___ + +### promises + +• `Const` **promises**: typeof [`internal`](internal-8.internal-3.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1413 + +## Functions + +### addAbortSignal + +▸ **addAbortSignal**<`T`\>(`signal`, `stream`): `T` + +A stream to attach a signal to. + +Attaches an AbortSignal to a readable or writeable stream. This lets code +control stream destruction using an `AbortController`. + +Calling `abort` on the `AbortController` corresponding to the passed`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`on the stream, and `controller.error(new +AbortError())` for webstreams. + +```js +const fs = require('node:fs'); + +const controller = new AbortController(); +const read = addAbortSignal( + controller.signal, + fs.createReadStream(('object.json')), +); +// Later, abort the operation closing the stream +controller.abort(); +``` + +Or using an `AbortSignal` with a readable stream as an async iterable: + +```js +const controller = new AbortController(); +setTimeout(() => controller.abort(), 10_000); // set a timeout +const stream = addAbortSignal( + controller.signal, + fs.createReadStream(('object.json')), +); +(async () => { + try { + for await (const chunk of stream) { + await process(chunk); + } + } catch (e) { + if (e.name === 'AbortError') { + // The operation was cancelled + } else { + throw e; + } + } +})(); +``` + +Or using an `AbortSignal` with a ReadableStream: + +```js +const controller = new AbortController(); +const rs = new ReadableStream({ + start(controller) { + controller.enqueue('hello'); + controller.enqueue('world'); + controller.close(); + }, +}); + +addAbortSignal(controller.signal, rs); + +finished(rs, (err) => { + if (err) { + if (err.name === 'AbortError') { + // The operation was cancelled + } + } +}); + +const reader = rs.getReader(); + +reader.read().then(({ value, done }) => { + console.log(value); // hello + console.log(done); // false + controller.abort(); +}); +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`Stream`](../classes/internal-8.Stream.md) | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `signal` | `AbortSignal` | A signal representing possible cancellation | +| `stream` | `T` | a stream to attach a signal to | + +#### Returns + +`T` + +**`Since`** + +v15.4.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1162 + +___ + +### finished + +▸ **finished**(`stream`, `options`, `callback`): () => `void` + +A readable and/or writable stream/webstream. + +A function to get notified when a stream is no longer readable, writable +or has experienced an error or a premature close event. + +```js +const { finished } = require('node:stream'); +const fs = require('node:fs'); + +const rs = fs.createReadStream('archive.tar'); + +finished(rs, (err) => { + if (err) { + console.error('Stream failed.', err); + } else { + console.log('Stream is done reading.'); + } +}); + +rs.resume(); // Drain the stream. +``` + +Especially useful in error handling scenarios where a stream is destroyed +prematurely (like an aborted HTTP request), and will not emit `'end'`or `'finish'`. + +The `finished` API provides `promise version`. + +`stream.finished()` leaves dangling event listeners (in particular`'error'`, `'end'`, `'finish'` and `'close'`) after `callback` has been +invoked. The reason for this is so that unexpected `'error'` events (due to +incorrect stream implementations) do not cause unexpected crashes. +If this is unwanted behavior then the returned cleanup function needs to be +invoked in the callback: + +```js +const cleanup = finished(rs, (err) => { + cleanup(); + // ... +}); +``` + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | A readable and/or writable stream. | +| `options` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) | - | +| `callback` | (`err?`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` | A callback function that takes an optional error argument. | + +#### Returns + +`fn` + +A cleanup function which removes all registered listeners. + +▸ (): `void` + +##### Returns + +`void` + +**`Since`** + +v10.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1227 + +▸ **finished**(`stream`, `callback`): () => `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `callback` | (`err?`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` | + +#### Returns + +`fn` + +▸ (): `void` + +##### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1228 + +___ + +### getDefaultHighWaterMark + +▸ **getDefaultHighWaterMark**(`objectMode`): `number` + +Returns the default highWaterMark used by streams. +Defaults to `16384` (16 KiB), or `16` for `objectMode`. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `objectMode` | `boolean` | + +#### Returns + +`number` + +**`Since`** + +v19.9.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1169 + +___ + +### isErrored + +▸ **isErrored**(`stream`): `boolean` + +Returns whether the stream has encountered an error. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`Writable`](../classes/internal-8.internal-2.Writable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v17.3.0, v16.14.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1406 + +___ + +### isReadable + +▸ **isReadable**(`stream`): `boolean` + +Returns whether the stream is readable. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) | + +#### Returns + +`boolean` + +**`Since`** + +v17.4.0, v16.14.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1412 + +___ + +### pipeline + +▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +A module method to pipe between streams and generators forwarding errors and +properly cleaning up and provide a callback when the pipeline is complete. + +```js +const { pipeline } = require('node:stream'); +const fs = require('node:fs'); +const zlib = require('node:zlib'); + +// Use the pipeline API to easily pipe a series of streams +// together and get notified when the pipeline is fully done. + +// A pipeline to gzip a potentially huge tar file efficiently: + +pipeline( + fs.createReadStream('archive.tar'), + zlib.createGzip(), + fs.createWriteStream('archive.tar.gz'), + (err) => { + if (err) { + console.error('Pipeline failed.', err); + } else { + console.log('Pipeline succeeded.'); + } + }, +); +``` + +The `pipeline` API provides a `promise version`. + +`stream.pipeline()` will call `stream.destroy(err)` on all streams except: + +* `Readable` streams which have emitted `'end'` or `'close'`. +* `Writable` streams which have emitted `'finish'` or `'close'`. + +`stream.pipeline()` leaves dangling event listeners on the streams +after the `callback` has been invoked. In the case of reuse of streams after +failure, this can cause event listener leaks and swallowed errors. If the last +stream is readable, dangling event listeners will be removed so that the last +stream can be consumed later. + +`stream.pipeline()` closes all the streams when an error is raised. +The `IncomingRequest` usage with `pipeline` could lead to an unexpected behavior +once it would destroy the socket without sending the expected response. +See the example below: + +```js +const fs = require('node:fs'); +const http = require('node:http'); +const { pipeline } = require('node:stream'); + +const server = http.createServer((req, res) => { + const fileStream = fs.createReadStream('./fileNotExist.txt'); + pipeline(fileStream, res, (err) => { + if (err) { + console.log(err); // No such file + // this message can't be sent once `pipeline` already destroyed the socket + return res.end('error!!!'); + } + }); +}); +``` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `source` | `A` | - | +| `destination` | `B` | - | +| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | Called when the pipeline is fully done. | + +#### Returns + +`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +**`Since`** + +v10.0.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1316 + +▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `destination` | `B` | +| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | + +#### Returns + +`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1321 + +▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `destination` | `B` | +| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | + +#### Returns + +`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1327 + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `destination` | `B` | +| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | + +#### Returns + +`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1334 + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `transform4` | `T4` | +| `destination` | `B` | +| `callback?` | [`PipelineCallback`](internal-8.internal-2.md#pipelinecallback)<`B`\> | + +#### Returns + +`B` extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) ? `B` : [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1341 + +▸ **pipeline**(`streams`, `callback?`): [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] | +| `callback?` | (`err`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void` | + +#### Returns + +[`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1349 + +▸ **pipeline**(`stream1`, `stream2`, `...streams`): [`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | +| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| (`err`: ``null`` \| [`ErrnoException`](../interfaces/internal-8.ErrnoException.md)) => `void`)[] | + +#### Returns + +[`WritableStream`](../interfaces/internal-8.WritableStream.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1353 + +___ + +### setDefaultHighWaterMark + +▸ **setDefaultHighWaterMark**(`objectMode`, `value`): `void` + +Sets the default highWaterMark used by streams. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `objectMode` | `boolean` | | +| `value` | `number` | highWaterMark value | + +#### Returns + +`void` + +**`Since`** + +v19.9.0 + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1176 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md new file mode 100644 index 0000000000..a7d4dfc892 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-2.pipeline.md @@ -0,0 +1,191 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: pipeline + +[internal](internal-8.md).[internal](internal-8.internal-2.md).pipeline + +## Functions + +### \_\_promisify\_\_ + +▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1359 + +▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1360 + +▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1366 + +▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1373 + +▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `transform4` | `T4` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1380 + +▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1388 + +▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | +| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md))[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1389 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md new file mode 100644 index 0000000000..5d91bec167 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-3.md @@ -0,0 +1,212 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +[internal](internal-8.md).internal + +## Functions + +### finished + +▸ **finished**(`stream`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `options?` | [`FinishedOptions`](../interfaces/internal-8.internal-2.FinishedOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:3 + +___ + +### pipeline + +▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:4 + +▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:5 + +▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:11 + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:18 + +▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | extends [`PipelineSource`](internal-8.internal-2.md#pipelinesource)<`any`\> | +| `T1` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`A`, `any`\> | +| `T2` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T1`, `any`\> | +| `T3` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T2`, `any`\> | +| `T4` | extends [`PipelineTransform`](internal-8.internal-2.md#pipelinetransform)<`T3`, `any`\> | +| `B` | extends [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`string` \| [`Buffer`](internal-8.md#buffer)\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`string` \| [`Buffer`](internal-8.md#buffer), `any`\> \| [`PipelineDestinationIterableFunction`](internal-8.internal-2.md#pipelinedestinationiterablefunction)<`any`\> \| [`PipelineDestinationPromiseFunction`](internal-8.internal-2.md#pipelinedestinationpromisefunction)<`any`, `any`\> | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `source` | `A` | +| `transform1` | `T1` | +| `transform2` | `T2` | +| `transform3` | `T3` | +| `transform4` | `T4` | +| `destination` | `B` | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +[`PipelinePromise`](internal-8.internal-2.md#pipelinepromise)<`B`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:25 + +▸ **pipeline**(`streams`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `streams` | readonly ([`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md))[] | +| `options?` | [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:33 + +▸ **pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream1` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) | +| `stream2` | [`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) | +| `...streams` | ([`WritableStream`](../interfaces/internal-8.WritableStream.md) \| [`ReadWriteStream`](../interfaces/internal-8.ReadWriteStream.md) \| [`PipelineOptions`](../interfaces/internal-8.internal-2.PipelineOptions.md))[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/promises.d.ts:34 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md new file mode 100644 index 0000000000..b55f699fc9 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal-4.md @@ -0,0 +1,107 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +[internal](internal-8.md).internal + +## Functions + +### arrayBuffer + +▸ **arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> | + +#### Returns + +`Promise`<`ArrayBuffer`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:6 + +___ + +### blob + +▸ **blob**(`stream`): `Promise`<[`Blob`](../classes/internal-8.Blob.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> | + +#### Returns + +`Promise`<[`Blob`](../classes/internal-8.Blob.md)\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:7 + +___ + +### buffer + +▸ **buffer**(`stream`): `Promise`<[`Buffer`](internal-8.md#buffer)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> | + +#### Returns + +`Promise`<[`Buffer`](internal-8.md#buffer)\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:4 + +___ + +### json + +▸ **json**(`stream`): `Promise`<`unknown`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> | + +#### Returns + +`Promise`<`unknown`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:8 + +___ + +### text + +▸ **text**(`stream`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](../interfaces/internal-8.ReadableStream.md) \| [`Readable`](../classes/internal-8.Readable.md) \| [`AsyncIterator`](../interfaces/internal-8.AsyncIterator.md)<`any`, `any`, `undefined`\> | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/consumers.d.ts:5 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.internal.md b/www/apps/docs/content/references/js-client/modules/internal-8.internal.md new file mode 100644 index 0000000000..5e2da612a7 --- /dev/null +++ b/www/apps/docs/content/references/js-client/modules/internal-8.internal.md @@ -0,0 +1,9655 @@ +--- +displayed_sidebar: jsClientSidebar +--- + +# Namespace: internal + +[internal](internal-8.md).internal + +## Enumerations + +- [PaymentCollectionType](../enums/internal-8.internal.PaymentCollectionType.md) +- [PaymentSessionStatus](../enums/internal-8.internal.PaymentSessionStatus.md) +- [PostgresError](../enums/internal-8.internal.PostgresError.md) +- [RefundReason](../enums/internal-8.internal.RefundReason.md) + +## Classes + +- [AbstractBatchJobStrategy](../classes/internal-8.internal.AbstractBatchJobStrategy.md) +- [AbstractCartCompletionStrategy](../classes/internal-8.internal.AbstractCartCompletionStrategy.md) +- [AbstractFileService](../classes/internal-8.internal.AbstractFileService.md) +- [AbstractFulfillmentService](../classes/internal-8.internal.AbstractFulfillmentService.md) +- [AbstractNotificationService](../classes/internal-8.internal.AbstractNotificationService.md) +- [AbstractPaymentProcessor](../classes/internal-8.internal.AbstractPaymentProcessor.md) +- [AbstractPaymentService](../classes/internal-8.internal.AbstractPaymentService.md) +- [AbstractPriceSelectionStrategy](../classes/internal-8.internal.AbstractPriceSelectionStrategy.md) +- [AbstractTaxService](../classes/internal-8.internal.AbstractTaxService.md) +- [AdminCreateUserRequest](../classes/internal-8.internal.AdminCreateUserRequest.md) +- [AdminDeleteDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionBatchParams.md) +- [AdminDeleteDiscountsDiscountConditionsConditionParams](../classes/internal-8.internal.AdminDeleteDiscountsDiscountConditionsConditionParams.md) +- [AdminDeletePriceListPricesPricesReq](../classes/internal-8.internal.AdminDeletePriceListPricesPricesReq.md) +- [AdminDeletePriceListsPriceListProductsPricesBatchReq](../classes/internal-8.internal.AdminDeletePriceListsPriceListProductsPricesBatchReq.md) +- [AdminDeleteProductCategoriesCategoryProductsBatchParams](../classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchParams.md) +- [AdminDeleteProductCategoriesCategoryProductsBatchReq](../classes/internal-8.internal.AdminDeleteProductCategoriesCategoryProductsBatchReq.md) +- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/internal-8.internal.AdminDeletePublishableApiKeySalesChannelsBatchReq.md) +- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-8.internal.AdminDeleteSalesChannelsChannelProductsBatchReq.md) +- [AdminDeleteSalesChannelsChannelStockLocationsReq](../classes/internal-8.internal.AdminDeleteSalesChannelsChannelStockLocationsReq.md) +- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) +- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) +- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsParams.md) +- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateProductsReq.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) +- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-8.internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) +- [AdminDeleteUploadsReq](../classes/internal-8.internal.AdminDeleteUploadsReq.md) +- [AdminGetDiscountParams](../classes/internal-8.internal.AdminGetDiscountParams.md) +- [AdminGetDiscountsDiscountCodeParams](../classes/internal-8.internal.AdminGetDiscountsDiscountCodeParams.md) +- [AdminGetDraftOrdersParams](../classes/internal-8.internal.AdminGetDraftOrdersParams.md) +- [AdminGetGiftCardsParams](../classes/internal-8.internal.AdminGetGiftCardsParams.md) +- [AdminGetInventoryItemsItemLocationLevelsParams](../classes/internal-8.internal.AdminGetInventoryItemsItemLocationLevelsParams.md) +- [AdminGetInventoryItemsItemParams](../classes/internal-8.internal.AdminGetInventoryItemsItemParams.md) +- [AdminGetInventoryItemsParams](../classes/internal-8.internal.AdminGetInventoryItemsParams.md) +- [AdminGetNotesParams](../classes/internal-8.internal.AdminGetNotesParams.md) +- [AdminGetNotificationsParams](../classes/internal-8.internal.AdminGetNotificationsParams.md) +- [AdminGetOrdersOrderParams](../classes/internal-8.internal.AdminGetOrdersOrderParams.md) +- [AdminGetOrdersParams](../classes/internal-8.internal.AdminGetOrdersParams.md) +- [AdminGetPaymentCollectionsParams](../classes/internal-8.internal.AdminGetPaymentCollectionsParams.md) +- [AdminGetPriceListPaginationParams](../classes/internal-8.internal.AdminGetPriceListPaginationParams.md) +- [AdminGetPriceListsPriceListProductsParams](../classes/internal-8.internal.AdminGetPriceListsPriceListProductsParams.md) +- [AdminGetProductCategoriesParams](../classes/internal-8.internal.AdminGetProductCategoriesParams.md) +- [AdminGetProductCategoryParams](../classes/internal-8.internal.AdminGetProductCategoryParams.md) +- [AdminGetProductTagsPaginationParams](../classes/internal-8.internal.AdminGetProductTagsPaginationParams.md) +- [AdminGetProductTagsParams](../classes/internal-8.internal.AdminGetProductTagsParams.md) +- [AdminGetProductTypesParams](../classes/internal-8.internal.AdminGetProductTypesParams.md) +- [AdminGetProductsParams](../classes/internal-8.internal.AdminGetProductsParams.md) +- [AdminGetProductsVariantsParams](../classes/internal-8.internal.AdminGetProductsVariantsParams.md) +- [AdminGetRegionsPaginationParams](../classes/internal-8.internal.AdminGetRegionsPaginationParams.md) +- [AdminGetRegionsParams](../classes/internal-8.internal.AdminGetRegionsParams.md) +- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-8.internal.AdminGetRegionsRegionFulfillmentOptionsRes.md) +- [AdminGetReservationsParams](../classes/internal-8.internal.AdminGetReservationsParams.md) +- [AdminGetReturnsParams](../classes/internal-8.internal.AdminGetReturnsParams.md) +- [AdminGetSalesChannelsParams](../classes/internal-8.internal.AdminGetSalesChannelsParams.md) +- [AdminGetShippingOptionsParams](../classes/internal-8.internal.AdminGetShippingOptionsParams.md) +- [AdminGetStockLocationsLocationParams](../classes/internal-8.internal.AdminGetStockLocationsLocationParams.md) +- [AdminGetStockLocationsParams](../classes/internal-8.internal.AdminGetStockLocationsParams.md) +- [AdminGetSwapsParams](../classes/internal-8.internal.AdminGetSwapsParams.md) +- [AdminGetTaxRatesParams](../classes/internal-8.internal.AdminGetTaxRatesParams.md) +- [AdminGetTaxRatesTaxRateParams](../classes/internal-8.internal.AdminGetTaxRatesTaxRateParams.md) +- [AdminGetVariantParams](../classes/internal-8.internal.AdminGetVariantParams.md) +- [AdminGetVariantsParams](../classes/internal-8.internal.AdminGetVariantsParams.md) +- [AdminPostAnalyticsConfigAnalyticsConfigReq](../classes/internal-8.internal.AdminPostAnalyticsConfigAnalyticsConfigReq.md) +- [AdminPostAnalyticsConfigReq](../classes/internal-8.internal.AdminPostAnalyticsConfigReq.md) +- [AdminPostDiscountsDiscountParams](../classes/internal-8.internal.AdminPostDiscountsDiscountParams.md) +- [AdminPostDiscountsParams](../classes/internal-8.internal.AdminPostDiscountsParams.md) +- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) +- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) +- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.internal.AdminPostDraftOrdersDraftOrderReq.md) +- [AdminPostDraftOrdersReq](../classes/internal-8.internal.AdminPostDraftOrdersReq.md) +- [AdminPostGiftCardsGiftCardReq](../classes/internal-8.internal.AdminPostGiftCardsGiftCardReq.md) +- [AdminPostGiftCardsReq](../classes/internal-8.internal.AdminPostGiftCardsReq.md) +- [AdminPostInventoryItemsInventoryItemParams](../classes/internal-8.internal.AdminPostInventoryItemsInventoryItemParams.md) +- [AdminPostInventoryItemsInventoryItemReq](../classes/internal-8.internal.AdminPostInventoryItemsInventoryItemReq.md) +- [AdminPostInventoryItemsItemLocationLevelsLevelParams](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelParams.md) +- [AdminPostInventoryItemsItemLocationLevelsLevelReq](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsLevelReq.md) +- [AdminPostInventoryItemsItemLocationLevelsParams](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsParams.md) +- [AdminPostInventoryItemsItemLocationLevelsReq](../classes/internal-8.internal.AdminPostInventoryItemsItemLocationLevelsReq.md) +- [AdminPostInventoryItemsParams](../classes/internal-8.internal.AdminPostInventoryItemsParams.md) +- [AdminPostInventoryItemsReq](../classes/internal-8.internal.AdminPostInventoryItemsReq.md) +- [AdminPostInvitesInviteAcceptReq](../classes/internal-8.internal.AdminPostInvitesInviteAcceptReq.md) +- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-8.internal.AdminPostInvitesInviteAcceptUserReq.md) +- [AdminPostInvitesReq](../classes/internal-8.internal.AdminPostInvitesReq.md) +- [AdminPostNotesNoteReq](../classes/internal-8.internal.AdminPostNotesNoteReq.md) +- [AdminPostNotesReq](../classes/internal-8.internal.AdminPostNotesReq.md) +- [AdminPostNotificationsNotificationResendReq](../classes/internal-8.internal.AdminPostNotificationsNotificationResendReq.md) +- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-8.internal.AdminPostOrderEditsEditLineItemsLineItemReq.md) +- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-8.internal.AdminPostOrderEditsEditLineItemsReq.md) +- [AdminPostOrderEditsOrderEditReq](../classes/internal-8.internal.AdminPostOrderEditsOrderEditReq.md) +- [AdminPostOrderEditsReq](../classes/internal-8.internal.AdminPostOrderEditsReq.md) +- [AdminPostOrderEditsRequestConfirmationReq](../classes/internal-8.internal.AdminPostOrderEditsRequestConfirmationReq.md) +- [AdminPostOrdersClaimCancel](../classes/internal-8.internal.AdminPostOrdersClaimCancel.md) +- [AdminPostOrdersClaimFulfillmentsCancelParams](../classes/internal-8.internal.AdminPostOrdersClaimFulfillmentsCancelParams.md) +- [AdminPostOrdersOrderArchiveParams](../classes/internal-8.internal.AdminPostOrdersOrderArchiveParams.md) +- [AdminPostOrdersOrderCancel](../classes/internal-8.internal.AdminPostOrdersOrderCancel.md) +- [AdminPostOrdersOrderCaptureParams](../classes/internal-8.internal.AdminPostOrdersOrderCaptureParams.md) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsParams.md) +- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) +- [AdminPostOrdersOrderClaimsClaimParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimParams.md) +- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md) +- [AdminPostOrdersOrderClaimsClaimShipmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsParams.md) +- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) +- [AdminPostOrdersOrderClaimsParams](../classes/internal-8.internal.AdminPostOrdersOrderClaimsParams.md) +- [AdminPostOrdersOrderClaimsReq](../classes/internal-8.internal.AdminPostOrdersOrderClaimsReq.md) +- [AdminPostOrdersOrderCompleteParams](../classes/internal-8.internal.AdminPostOrdersOrderCompleteParams.md) +- [AdminPostOrdersOrderFulfillementsCancelParams](../classes/internal-8.internal.AdminPostOrdersOrderFulfillementsCancelParams.md) +- [AdminPostOrdersOrderFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsParams.md) +- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderFulfillmentsReq.md) +- [AdminPostOrdersOrderParams](../classes/internal-8.internal.AdminPostOrdersOrderParams.md) +- [AdminPostOrdersOrderRefundsParams](../classes/internal-8.internal.AdminPostOrdersOrderRefundsParams.md) +- [AdminPostOrdersOrderRefundsReq](../classes/internal-8.internal.AdminPostOrdersOrderRefundsReq.md) +- [AdminPostOrdersOrderReq](../classes/internal-8.internal.AdminPostOrdersOrderReq.md) +- [AdminPostOrdersOrderReturnsParams](../classes/internal-8.internal.AdminPostOrdersOrderReturnsParams.md) +- [AdminPostOrdersOrderReturnsReq](../classes/internal-8.internal.AdminPostOrdersOrderReturnsReq.md) +- [AdminPostOrdersOrderShipmentParams](../classes/internal-8.internal.AdminPostOrdersOrderShipmentParams.md) +- [AdminPostOrdersOrderShipmentReq](../classes/internal-8.internal.AdminPostOrdersOrderShipmentReq.md) +- [AdminPostOrdersOrderShippingMethodsParams](../classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsParams.md) +- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-8.internal.AdminPostOrdersOrderShippingMethodsReq.md) +- [AdminPostOrdersOrderSwapFulfillementsCancelParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapFulfillementsCancelParams.md) +- [AdminPostOrdersOrderSwapsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsParams.md) +- [AdminPostOrdersOrderSwapsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsReq.md) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsParams.md) +- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) +- [AdminPostOrdersOrderSwapsSwapProcessPaymentParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapProcessPaymentParams.md) +- [AdminPostOrdersOrderSwapsSwapShipmentsParams](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsParams.md) +- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-8.internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) +- [AdminPostOrdersSwapCancelParams](../classes/internal-8.internal.AdminPostOrdersSwapCancelParams.md) +- [AdminPostPaymentRefundsReq](../classes/internal-8.internal.AdminPostPaymentRefundsReq.md) +- [AdminPostPriceListPricesPricesReq](../classes/internal-8.internal.AdminPostPriceListPricesPricesReq.md) +- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-8.internal.AdminPostPriceListsPriceListPriceListReq.md) +- [AdminPostPriceListsPriceListReq](../classes/internal-8.internal.AdminPostPriceListsPriceListReq.md) +- [AdminPostProductCategoriesCategoryParams](../classes/internal-8.internal.AdminPostProductCategoriesCategoryParams.md) +- [AdminPostProductCategoriesCategoryProductsBatchParams](../classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchParams.md) +- [AdminPostProductCategoriesCategoryProductsBatchReq](../classes/internal-8.internal.AdminPostProductCategoriesCategoryProductsBatchReq.md) +- [AdminPostProductCategoriesCategoryReq](../classes/internal-8.internal.AdminPostProductCategoriesCategoryReq.md) +- [AdminPostProductCategoriesParams](../classes/internal-8.internal.AdminPostProductCategoriesParams.md) +- [AdminPostProductCategoriesReq](../classes/internal-8.internal.AdminPostProductCategoriesReq.md) +- [AdminPostProductsProductMetadataReq](../classes/internal-8.internal.AdminPostProductsProductMetadataReq.md) +- [AdminPostProductsProductOptionsOption](../classes/internal-8.internal.AdminPostProductsProductOptionsOption.md) +- [AdminPostProductsProductOptionsReq](../classes/internal-8.internal.AdminPostProductsProductOptionsReq.md) +- [AdminPostProductsProductReq](../classes/internal-8.internal.AdminPostProductsProductReq.md) +- [AdminPostProductsProductVariantsReq](../classes/internal-8.internal.AdminPostProductsProductVariantsReq.md) +- [AdminPostProductsProductVariantsVariantReq](../classes/internal-8.internal.AdminPostProductsProductVariantsVariantReq.md) +- [AdminPostProductsReq](../classes/internal-8.internal.AdminPostProductsReq.md) +- [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/internal-8.internal.AdminPostPublishableApiKeySalesChannelsBatchReq.md) +- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-8.internal.AdminPostPublishableApiKeysPublishableApiKeyReq.md) +- [AdminPostPublishableApiKeysReq](../classes/internal-8.internal.AdminPostPublishableApiKeysReq.md) +- [AdminPostRegionsRegionCountriesReq](../classes/internal-8.internal.AdminPostRegionsRegionCountriesReq.md) +- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-8.internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) +- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-8.internal.AdminPostRegionsRegionPaymentProvidersReq.md) +- [AdminPostRegionsRegionReq](../classes/internal-8.internal.AdminPostRegionsRegionReq.md) +- [AdminPostRegionsReq](../classes/internal-8.internal.AdminPostRegionsReq.md) +- [AdminPostReservationsReq](../classes/internal-8.internal.AdminPostReservationsReq.md) +- [AdminPostReservationsReservationReq](../classes/internal-8.internal.AdminPostReservationsReservationReq.md) +- [AdminPostReturnReasonsReasonReq](../classes/internal-8.internal.AdminPostReturnReasonsReasonReq.md) +- [AdminPostReturnReasonsReq](../classes/internal-8.internal.AdminPostReturnReasonsReq.md) +- [AdminPostReturnsReturnReceiveReq](../classes/internal-8.internal.AdminPostReturnsReturnReceiveReq.md) +- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-8.internal.AdminPostSalesChannelsChannelProductsBatchReq.md) +- [AdminPostSalesChannelsChannelStockLocationsReq](../classes/internal-8.internal.AdminPostSalesChannelsChannelStockLocationsReq.md) +- [AdminPostSalesChannelsReq](../classes/internal-8.internal.AdminPostSalesChannelsReq.md) +- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-8.internal.AdminPostSalesChannelsSalesChannelReq.md) +- [AdminPostShippingOptionsOptionReq](../classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md) +- [AdminPostShippingOptionsReq](../classes/internal-8.internal.AdminPostShippingOptionsReq.md) +- [AdminPostShippingProfilesProfileReq](../classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md) +- [AdminPostShippingProfilesReq](../classes/internal-8.internal.AdminPostShippingProfilesReq.md) +- [AdminPostStockLocationsLocationParams](../classes/internal-8.internal.AdminPostStockLocationsLocationParams.md) +- [AdminPostStockLocationsLocationReq](../classes/internal-8.internal.AdminPostStockLocationsLocationReq.md) +- [AdminPostStockLocationsParams](../classes/internal-8.internal.AdminPostStockLocationsParams.md) +- [AdminPostStockLocationsReq](../classes/internal-8.internal.AdminPostStockLocationsReq.md) +- [AdminPostStoreReq](../classes/internal-8.internal.AdminPostStoreReq.md) +- [AdminPostTaxRatesParams](../classes/internal-8.internal.AdminPostTaxRatesParams.md) +- [AdminPostTaxRatesReq](../classes/internal-8.internal.AdminPostTaxRatesReq.md) +- [AdminPostTaxRatesTaxRateParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateParams.md) +- [AdminPostTaxRatesTaxRateProductTypesParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesParams.md) +- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductTypesReq.md) +- [AdminPostTaxRatesTaxRateProductsParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsParams.md) +- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateProductsReq.md) +- [AdminPostTaxRatesTaxRateReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateReq.md) +- [AdminPostTaxRatesTaxRateShippingOptionsParams](../classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsParams.md) +- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-8.internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) +- [AdminPostUploadsDownloadUrlReq](../classes/internal-8.internal.AdminPostUploadsDownloadUrlReq.md) +- [AdminPriceListPricesCreateReq](../classes/internal-8.internal.AdminPriceListPricesCreateReq.md) +- [AdminPriceListPricesUpdateReq](../classes/internal-8.internal.AdminPriceListPricesUpdateReq.md) +- [AdminRegionsRes](../classes/internal-8.internal.AdminRegionsRes.md) +- [AdminResetPasswordRequest](../classes/internal-8.internal.AdminResetPasswordRequest.md) +- [AdminResetPasswordTokenRequest](../classes/internal-8.internal.AdminResetPasswordTokenRequest.md) +- [AdminUpdatePaymentCollectionsReq](../classes/internal-8.internal.AdminUpdatePaymentCollectionsReq.md) +- [AdminUpdateUserRequest](../classes/internal-8.internal.AdminUpdateUserRequest.md) +- [AnalyticsConfig](../classes/internal-8.internal.AnalyticsConfig.md) +- [AnalyticsConfigService](../classes/internal-8.internal.AnalyticsConfigService.md) +- [AuthService](../classes/internal-8.internal.AuthService.md) +- [BatchJobService](../classes/internal-8.internal.BatchJobService.md) +- [CartService](../classes/internal-8.internal.CartService.md) +- [ClaimItemService](../classes/internal-8.internal.ClaimItemService.md) +- [ClaimService](../classes/internal-8.internal.ClaimService.md) +- [CurrencyService](../classes/internal-8.internal.CurrencyService.md) +- [CustomShippingOption](../classes/internal-8.internal.CustomShippingOption.md) +- [CustomShippingOptionService](../classes/internal-8.internal.CustomShippingOptionService.md) +- [CustomerGroupService](../classes/internal-8.internal.CustomerGroupService.md) +- [CustomerService](../classes/internal-8.internal.CustomerService.md) +- [DiscountConditionCustomerGroup](../classes/internal-8.internal.DiscountConditionCustomerGroup.md) +- [DiscountConditionProduct](../classes/internal-8.internal.DiscountConditionProduct.md) +- [DiscountConditionProductCollection](../classes/internal-8.internal.DiscountConditionProductCollection.md) +- [DiscountConditionProductTag](../classes/internal-8.internal.DiscountConditionProductTag.md) +- [DiscountConditionProductType](../classes/internal-8.internal.DiscountConditionProductType.md) +- [DiscountConditionService](../classes/internal-8.internal.DiscountConditionService.md) +- [DiscountService](../classes/internal-8.internal.DiscountService.md) +- [DraftOrderService](../classes/internal-8.internal.DraftOrderService.md) +- [EmptyQueryParams](../classes/internal-8.internal.EmptyQueryParams.md) +- [EventBusService](../classes/internal-8.internal.EventBusService.md) +- [FilterableBatchJobProps](../classes/internal-8.internal.FilterableBatchJobProps.md) +- [FilterablePriceListProps](../classes/internal-8.internal.FilterablePriceListProps.md) +- [FulfillmentOption](../classes/internal-8.internal.FulfillmentOption.md) +- [FulfillmentProviderService](../classes/internal-8.internal.FulfillmentProviderService.md) +- [GetOrderEditsOrderEditParams](../classes/internal-8.internal.GetOrderEditsOrderEditParams.md) +- [GetOrderEditsParams](../classes/internal-8.internal.GetOrderEditsParams.md) +- [GetPaymentsParams](../classes/internal-8.internal.GetPaymentsParams.md) +- [GetPublishableApiKeySalesChannelsParams](../classes/internal-8.internal.GetPublishableApiKeySalesChannelsParams.md) +- [GetPublishableApiKeysParams](../classes/internal-8.internal.GetPublishableApiKeysParams.md) +- [GiftCardService](../classes/internal-8.internal.GiftCardService.md) +- [IAdminPostUploadsFileReq](../classes/internal-8.internal.IAdminPostUploadsFileReq.md) +- [IdempotencyKey](../classes/internal-8.internal.IdempotencyKey.md) +- [IdempotencyKeyService](../classes/internal-8.internal.IdempotencyKeyService.md) +- [Invite](../classes/internal-8.internal.Invite.md) +- [Item](../classes/internal-8.internal.Item.md) +- [LineItemAdjustmentService](../classes/internal-8.internal.LineItemAdjustmentService.md) +- [LineItemService](../classes/internal-8.internal.LineItemService.md) +- [MiddlewareService](../classes/internal-8.internal.MiddlewareService.md) +- [NewTotalsService](../classes/internal-8.internal.NewTotalsService.md) +- [Note](../classes/internal-8.internal.Note.md) +- [NoteService](../classes/internal-8.internal.NoteService.md) +- [Notification](../classes/internal-8.internal.Notification.md) +- [NotificationService](../classes/internal-8.internal.NotificationService.md) +- [NumericalComparisonOperator](../classes/internal-8.internal.NumericalComparisonOperator.md) +- [Oauth](../classes/internal-8.internal.Oauth.md) +- [OauthService](../classes/internal-8.internal.OauthService.md) +- [OrderEditItemChangeService](../classes/internal-8.internal.OrderEditItemChangeService.md) +- [OrderEditService](../classes/internal-8.internal.OrderEditService.md) +- [OrderService](../classes/internal-8.internal.OrderService.md) +- [PaymentCollectionService](../classes/internal-8.internal.PaymentCollectionService.md) +- [PaymentProviderService](../classes/internal-8.internal.PaymentProviderService.md) +- [PriceListService](../classes/internal-8.internal.PriceListService.md) +- [PricingService](../classes/internal-8.internal.PricingService.md) +- [ProductCategoryService](../classes/internal-8.internal.ProductCategoryService.md) +- [ProductCollectionService](../classes/internal-8.internal.ProductCollectionService.md) +- [ProductService](../classes/internal-8.internal.ProductService.md) +- [ProductTaxRate](../classes/internal-8.internal.ProductTaxRate.md) +- [ProductTypeService](../classes/internal-8.internal.ProductTypeService.md) +- [ProductTypeTaxRate](../classes/internal-8.internal.ProductTypeTaxRate.md) +- [ProductVariantInventoryService](../classes/internal-8.internal.ProductVariantInventoryService.md) +- [ProductVariantMoneyAmount](../classes/internal-8.internal.ProductVariantMoneyAmount.md) +- [ProductVariantService](../classes/internal-8.internal.ProductVariantService.md) +- [PublishableApiKey](../classes/internal-8.internal.PublishableApiKey.md) +- [PublishableApiKeySalesChannel](../classes/internal-8.internal.PublishableApiKeySalesChannel.md) +- [RegionService](../classes/internal-8.internal.RegionService.md) +- [ReturnReasonService](../classes/internal-8.internal.ReturnReasonService.md) +- [ReturnService](../classes/internal-8.internal.ReturnService.md) +- [SalesChannelInventoryService](../classes/internal-8.internal.SalesChannelInventoryService.md) +- [SalesChannelLocationService](../classes/internal-8.internal.SalesChannelLocationService.md) +- [SalesChannelService](../classes/internal-8.internal.SalesChannelService.md) +- [SearchService](../classes/internal-8.internal.SearchService.md) +- [ShippingAddressPayload](../classes/internal-8.internal.ShippingAddressPayload.md) +- [ShippingOptionService](../classes/internal-8.internal.ShippingOptionService.md) +- [ShippingProfileService](../classes/internal-8.internal.ShippingProfileService.md) +- [ShippingTaxRate](../classes/internal-8.internal.ShippingTaxRate.md) +- [StagedJob](../classes/internal-8.internal.StagedJob.md) +- [StagedJobService](../classes/internal-8.internal.StagedJobService.md) +- [Store](../classes/internal-8.internal.Store.md) +- [StoreGetCollectionsParams](../classes/internal-8.internal.StoreGetCollectionsParams.md) +- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-8.internal.StoreGetCustomersCustomerOrdersPaginationParams.md) +- [StoreGetCustomersCustomerOrdersParams](../classes/internal-8.internal.StoreGetCustomersCustomerOrdersParams.md) +- [StoreGetOrdersParams](../classes/internal-8.internal.StoreGetOrdersParams.md) +- [StoreGetPaymentCollectionsParams](../classes/internal-8.internal.StoreGetPaymentCollectionsParams.md) +- [StoreGetProductCategoriesCategoryParams](../classes/internal-8.internal.StoreGetProductCategoriesCategoryParams.md) +- [StoreGetProductCategoriesParams](../classes/internal-8.internal.StoreGetProductCategoriesParams.md) +- [StoreGetProductTagsParams](../classes/internal-8.internal.StoreGetProductTagsParams.md) +- [StoreGetProductTypesParams](../classes/internal-8.internal.StoreGetProductTypesParams.md) +- [StoreGetProductsPaginationParams](../classes/internal-8.internal.StoreGetProductsPaginationParams.md) +- [StoreGetProductsParams](../classes/internal-8.internal.StoreGetProductsParams.md) +- [StoreGetRegionsParams](../classes/internal-8.internal.StoreGetRegionsParams.md) +- [StoreGetShippingOptionsParams](../classes/internal-8.internal.StoreGetShippingOptionsParams.md) +- [StoreGetVariantsParams](../classes/internal-8.internal.StoreGetVariantsParams.md) +- [StoreGetVariantsVariantParams](../classes/internal-8.internal.StoreGetVariantsVariantParams.md) +- [StorePaymentCollectionSessionsReq](../classes/internal-8.internal.StorePaymentCollectionSessionsReq.md) +- [StorePostAuthReq](../classes/internal-8.internal.StorePostAuthReq.md) +- [StorePostCartReq](../classes/internal-8.internal.StorePostCartReq.md) +- [StorePostCartsCartLineItemsItemReq](../classes/internal-8.internal.StorePostCartsCartLineItemsItemReq.md) +- [StorePostCartsCartLineItemsReq](../classes/internal-8.internal.StorePostCartsCartLineItemsReq.md) +- [StorePostCartsCartPaymentSessionReq](../classes/internal-8.internal.StorePostCartsCartPaymentSessionReq.md) +- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-8.internal.StorePostCartsCartPaymentSessionUpdateReq.md) +- [StorePostCartsCartReq](../classes/internal-8.internal.StorePostCartsCartReq.md) +- [StorePostCartsCartShippingMethodReq](../classes/internal-8.internal.StorePostCartsCartShippingMethodReq.md) +- [StorePostCustomersCustomerAcceptClaimReq](../classes/internal-8.internal.StorePostCustomersCustomerAcceptClaimReq.md) +- [StorePostCustomersCustomerOrderClaimReq](../classes/internal-8.internal.StorePostCustomersCustomerOrderClaimReq.md) +- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-8.internal.StorePostCustomersCustomerPasswordTokenReq.md) +- [StorePostCustomersCustomerReq](../classes/internal-8.internal.StorePostCustomersCustomerReq.md) +- [StorePostCustomersReq](../classes/internal-8.internal.StorePostCustomersReq.md) +- [StorePostCustomersResetPasswordReq](../classes/internal-8.internal.StorePostCustomersResetPasswordReq.md) +- [StorePostOrderEditsOrderEditDecline](../classes/internal-8.internal.StorePostOrderEditsOrderEditDecline.md) +- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md) +- [StorePostPaymentCollectionsBatchSessionsReq](../classes/internal-8.internal.StorePostPaymentCollectionsBatchSessionsReq.md) +- [StorePostPaymentCollectionsSessionsReq](../classes/internal-8.internal.StorePostPaymentCollectionsSessionsReq.md) +- [StorePostReturnsReq](../classes/internal-8.internal.StorePostReturnsReq.md) +- [StorePostSearchReq](../classes/internal-8.internal.StorePostSearchReq.md) +- [StorePostSwapsReq](../classes/internal-8.internal.StorePostSwapsReq.md) +- [StoreService](../classes/internal-8.internal.StoreService.md) +- [StrategyResolverService](../classes/internal-8.internal.StrategyResolverService.md) +- [SwapService](../classes/internal-8.internal.SwapService.md) +- [SystemPaymentProviderService](../classes/internal-8.internal.SystemPaymentProviderService.md) +- [TaxProviderService](../classes/internal-8.internal.TaxProviderService.md) +- [TaxRateService](../classes/internal-8.internal.TaxRateService.md) +- [TokenService](../classes/internal-8.internal.TokenService.md) +- [TotalsService](../classes/internal-8.internal.TotalsService.md) +- [TransactionBaseService](../classes/internal-8.internal.TransactionBaseService.md) +- [UserService](../classes/internal-8.internal.UserService.md) + +## Interfaces + +- [CustomFindOptions](../interfaces/internal-8.internal.CustomFindOptions.md) +- [FindConfig](../interfaces/internal-8.internal.FindConfig.md) +- [FulfillmentService](../interfaces/internal-8.internal.FulfillmentService.md) +- [IBatchJobStrategy](../interfaces/internal-8.internal.IBatchJobStrategy.md) +- [ICartCompletionStrategy](../interfaces/internal-8.internal.ICartCompletionStrategy.md) +- [IFileService](../interfaces/internal-8.internal.IFileService.md) +- [INotificationService](../interfaces/internal-8.internal.INotificationService.md) +- [IPriceSelectionStrategy](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) +- [ITaxCalculationStrategy](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) +- [ITaxService](../interfaces/internal-8.internal.ITaxService.md) +- [PaymentProcessor](../interfaces/internal-8.internal.PaymentProcessor.md) +- [PaymentProcessorError](../interfaces/internal-8.internal.PaymentProcessorError.md) +- [PaymentService](../interfaces/internal-8.internal.PaymentService.md) + +## References + +### Address + +Re-exports [Address](../classes/internal-3.Address.md) + +___ + +### AddressCreatePayload + +Re-exports [AddressCreatePayload](../classes/internal.AddressCreatePayload.md) + +___ + +### AddressPayload + +Re-exports [AddressPayload](../classes/internal.AddressPayload.md) + +___ + +### AdminAuthRes + +Re-exports [AdminAuthRes](internal-1.md#adminauthres) + +___ + +### AdminBatchJobListRes + +Re-exports [AdminBatchJobListRes](internal-2.md#adminbatchjoblistres) + +___ + +### AdminBatchJobRes + +Re-exports [AdminBatchJobRes](internal-2.md#adminbatchjobres) + +___ + +### AdminBearerAuthRes + +Re-exports [AdminBearerAuthRes](internal-1.md#adminbearerauthres) + +___ + +### AdminCollectionsListRes + +Re-exports [AdminCollectionsListRes](internal-3.md#admincollectionslistres) + +___ + +### AdminCollectionsRes + +Re-exports [AdminCollectionsRes](internal-3.md#admincollectionsres) + +___ + +### AdminCreateCondition + +Re-exports [AdminCreateCondition](../classes/internal-8.AdminCreateCondition.md) + +___ + +### AdminCurrenciesListRes + +Re-exports [AdminCurrenciesListRes](internal-4.md#admincurrencieslistres) + +___ + +### AdminCurrenciesRes + +Re-exports [AdminCurrenciesRes](internal-4.md#admincurrenciesres) + +___ + +### AdminCustomerGroupsListRes + +Re-exports [AdminCustomerGroupsListRes](internal-6.md#admincustomergroupslistres) + +___ + +### AdminCustomerGroupsRes + +Re-exports [AdminCustomerGroupsRes](internal-6.md#admincustomergroupsres) + +___ + +### AdminCustomersListRes + +Re-exports [AdminCustomersListRes](internal-7.md#admincustomerslistres) + +___ + +### AdminCustomersRes + +Re-exports [AdminCustomersRes](internal-7.md#admincustomersres) + +___ + +### AdminDeleteCustomerGroupsGroupCustomerBatchReq + +Re-exports [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-6.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) + +___ + +### AdminDeleteDiscountsDiscountConditionsConditionBatchReq + +Re-exports [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) + +___ + +### AdminDeleteProductsFromCollectionReq + +Re-exports [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md) + +___ + +### AdminDeleteProductsFromCollectionRes + +Re-exports [AdminDeleteProductsFromCollectionRes](internal-3.md#admindeleteproductsfromcollectionres) + +___ + +### AdminDiscountConditionsRes + +Re-exports [AdminDiscountConditionsRes](internal-8.md#admindiscountconditionsres) + +___ + +### AdminDiscountsListRes + +Re-exports [AdminDiscountsListRes](internal-8.md#admindiscountslistres) + +___ + +### AdminDiscountsRes + +Re-exports [AdminDiscountsRes](internal-8.md#admindiscountsres) + +___ + +### AdminGetBatchPaginationParams + +Re-exports [AdminGetBatchPaginationParams](../classes/internal-2.AdminGetBatchPaginationParams.md) + +___ + +### AdminGetBatchParams + +Re-exports [AdminGetBatchParams](../classes/internal-2.AdminGetBatchParams.md) + +___ + +### AdminGetCollectionsPaginationParams + +Re-exports [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md) + +___ + +### AdminGetCollectionsParams + +Re-exports [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md) + +___ + +### AdminGetCurrenciesParams + +Re-exports [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md) + +___ + +### AdminGetCustomerGroupsGroupParams + +Re-exports [AdminGetCustomerGroupsGroupParams](../classes/internal-6.AdminGetCustomerGroupsGroupParams.md) + +___ + +### AdminGetCustomerGroupsParams + +Re-exports [AdminGetCustomerGroupsParams](../classes/internal-6.AdminGetCustomerGroupsParams.md) + +___ + +### AdminGetCustomersParams + +Re-exports [AdminGetCustomersParams](../classes/internal-7.AdminGetCustomersParams.md) + +___ + +### AdminGetDiscountsDiscountConditionsConditionParams + +Re-exports [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) + +___ + +### AdminGetDiscountsParams + +Re-exports [AdminGetDiscountsParams](../classes/internal-8.AdminGetDiscountsParams.md) + +___ + +### AdminPostAuthReq + +Re-exports [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md) + +___ + +### AdminPostBatchesReq + +Re-exports [AdminPostBatchesReq](../classes/internal-2.AdminPostBatchesReq.md) + +___ + +### AdminPostCollectionsCollectionReq + +Re-exports [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md) + +___ + +### AdminPostCollectionsReq + +Re-exports [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md) + +___ + +### AdminPostCurrenciesCurrencyReq + +Re-exports [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md) + +___ + +### AdminPostCustomerGroupsGroupCustomersBatchReq + +Re-exports [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-6.AdminPostCustomerGroupsGroupCustomersBatchReq.md) + +___ + +### AdminPostCustomerGroupsGroupReq + +Re-exports [AdminPostCustomerGroupsGroupReq](../classes/internal-6.AdminPostCustomerGroupsGroupReq.md) + +___ + +### AdminPostCustomerGroupsReq + +Re-exports [AdminPostCustomerGroupsReq](../classes/internal-6.AdminPostCustomerGroupsReq.md) + +___ + +### AdminPostCustomersCustomerReq + +Re-exports [AdminPostCustomersCustomerReq](../classes/internal-7.AdminPostCustomersCustomerReq.md) + +___ + +### AdminPostCustomersReq + +Re-exports [AdminPostCustomersReq](../classes/internal-7.AdminPostCustomersReq.md) + +___ + +### AdminPostDiscountsDiscountConditions + +Re-exports [AdminPostDiscountsDiscountConditions](../classes/internal-8.AdminPostDiscountsDiscountConditions.md) + +___ + +### AdminPostDiscountsDiscountConditionsCondition + +Re-exports [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md) + +___ + +### AdminPostDiscountsDiscountConditionsConditionBatchParams + +Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) + +___ + +### AdminPostDiscountsDiscountConditionsConditionBatchReq + +Re-exports [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) + +___ + +### AdminPostDiscountsDiscountConditionsConditionParams + +Re-exports [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) + +___ + +### AdminPostDiscountsDiscountConditionsParams + +Re-exports [AdminPostDiscountsDiscountConditionsParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md) + +___ + +### AdminPostDiscountsDiscountDynamicCodesReq + +Re-exports [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) + +___ + +### AdminPostDiscountsDiscountReq + +Re-exports [AdminPostDiscountsDiscountReq](../classes/internal-8.AdminPostDiscountsDiscountReq.md) + +___ + +### AdminPostDiscountsDiscountRule + +Re-exports [AdminPostDiscountsDiscountRule](../classes/internal-8.AdminPostDiscountsDiscountRule.md) + +___ + +### AdminPostDiscountsReq + +Re-exports [AdminPostDiscountsReq](../classes/internal-8.AdminPostDiscountsReq.md) + +___ + +### AdminPostProductsToCollectionReq + +Re-exports [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md) + +___ + +### AdminUpdateDiscountRule + +Re-exports [AdminUpdateDiscountRule](../classes/internal-8.AdminUpdateDiscountRule.md) + +___ + +### AdminUpsertCondition + +Re-exports [AdminUpsertCondition](../classes/internal-8.AdminUpsertCondition.md) + +___ + +### AllocationType + +Re-exports [AllocationType](../enums/internal-3.AllocationType.md) + +___ + +### BaseEntity + +Re-exports [BaseEntity](../classes/internal-1.BaseEntity.md) + +___ + +### BatchJob + +Re-exports [BatchJob](../classes/internal-2.BatchJob.md) + +___ + +### BatchJobResultError + +Re-exports [BatchJobResultError](internal-2.md#batchjobresulterror) + +___ + +### BatchJobResultStatDescriptor + +Re-exports [BatchJobResultStatDescriptor](internal-2.md#batchjobresultstatdescriptor) + +___ + +### BatchJobStatus + +Re-exports [BatchJobStatus](../enums/internal-2.BatchJobStatus.md) + +___ + +### Cart + +Re-exports [Cart](../classes/internal-3.Cart.md) + +___ + +### CartType + +Re-exports [CartType](../enums/internal-3.CartType.md) + +___ + +### ClaimFulfillmentStatus + +Re-exports [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md) + +___ + +### ClaimImage + +Re-exports [ClaimImage](../classes/internal-3.ClaimImage.md) + +___ + +### ClaimItem + +Re-exports [ClaimItem](../classes/internal-3.ClaimItem.md) + +___ + +### ClaimOrder + +Re-exports [ClaimOrder](../classes/internal-3.ClaimOrder.md) + +___ + +### ClaimPaymentStatus + +Re-exports [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md) + +___ + +### ClaimReason + +Re-exports [ClaimReason](../enums/internal-3.ClaimReason.md) + +___ + +### ClaimTag + +Re-exports [ClaimTag](../classes/internal-3.ClaimTag.md) + +___ + +### ClaimType + +Re-exports [ClaimType](../enums/internal-3.ClaimType.md) + +___ + +### Country + +Re-exports [Country](../classes/internal-3.Country.md) + +___ + +### Currency + +Re-exports [Currency](../classes/internal-3.Currency.md) + +___ + +### Customer + +Re-exports [Customer](../classes/internal-3.Customer.md) + +___ + +### CustomerGroup + +Re-exports [CustomerGroup](../classes/internal-3.CustomerGroup.md) + +___ + +### DateComparisonOperator + +Re-exports [DateComparisonOperator](../classes/internal-2.DateComparisonOperator.md) + +___ + +### Discount + +Re-exports [Discount](../classes/internal-3.Discount.md) + +___ + +### DiscountCondition + +Re-exports [DiscountCondition](../classes/internal-3.DiscountCondition.md) + +___ + +### DiscountConditionOperator + +Re-exports [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md) + +___ + +### DiscountConditionType + +Re-exports [DiscountConditionType](../enums/internal-3.DiscountConditionType.md) + +___ + +### DiscountRule + +Re-exports [DiscountRule](../classes/internal-3.DiscountRule.md) + +___ + +### DiscountRuleType + +Re-exports [DiscountRuleType](../enums/internal-3.DiscountRuleType.md) + +___ + +### DraftOrder + +Re-exports [DraftOrder](../classes/internal-3.DraftOrder.md) + +___ + +### DraftOrderStatus + +Re-exports [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md) + +___ + +### FindPaginationParams + +Re-exports [FindPaginationParams](../classes/internal-4.FindPaginationParams.md) + +___ + +### FindParams + +Re-exports [FindParams](../classes/internal-6.FindParams.md) + +___ + +### Fulfillment + +Re-exports [Fulfillment](../classes/internal-3.Fulfillment.md) + +___ + +### FulfillmentItem + +Re-exports [FulfillmentItem](../classes/internal-3.FulfillmentItem.md) + +___ + +### FulfillmentProvider + +Re-exports [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md) + +___ + +### FulfillmentStatus + +Re-exports [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md) + +___ + +### GiftCard + +Re-exports [GiftCard](../classes/internal-3.GiftCard.md) + +___ + +### GiftCardTransaction + +Re-exports [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md) + +___ + +### Image + +Re-exports [Image](../classes/internal-3.Image.md) + +___ + +### LineItem + +Re-exports [LineItem](../classes/internal-3.LineItem.md) + +___ + +### LineItemAdjustment + +Re-exports [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md) + +___ + +### LineItemTaxLine + +Re-exports [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md) + +___ + +### MoneyAmount + +Re-exports [MoneyAmount](../classes/internal-3.MoneyAmount.md) + +___ + +### Order + +Re-exports [Order](../classes/internal-3.Order.md) + +___ + +### OrderEdit + +Re-exports [OrderEdit](../classes/internal-3.OrderEdit.md) + +___ + +### OrderEditItemChangeType + +Re-exports [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md) + +___ + +### OrderEditStatus + +Re-exports [OrderEditStatus](../enums/internal-3.OrderEditStatus.md) + +___ + +### OrderItemChange + +Re-exports [OrderItemChange](../classes/internal-3.OrderItemChange.md) + +___ + +### OrderStatus + +Re-exports [OrderStatus](../enums/internal-3.OrderStatus.md) + +___ + +### PaginatedResponse + +Re-exports [PaginatedResponse](internal-2.md#paginatedresponse) + +___ + +### Payment + +Re-exports [Payment](../classes/internal-3.Payment.md) + +___ + +### PaymentCollection + +Re-exports [PaymentCollection](../classes/internal-3.PaymentCollection.md) + +___ + +### PaymentCollectionStatus + +Re-exports [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md) + +___ + +### PaymentProvider + +Re-exports [PaymentProvider](../classes/internal-3.PaymentProvider.md) + +___ + +### PaymentSession + +Re-exports [PaymentSession](../classes/internal-3.PaymentSession.md) + +___ + +### PaymentStatus + +Re-exports [PaymentStatus](../enums/internal-3.PaymentStatus.md) + +___ + +### PriceList + +Re-exports [PriceList](../classes/internal-3.PriceList.md) + +___ + +### PriceListStatus + +Re-exports [PriceListStatus](../enums/internal-3.PriceListStatus.md) + +___ + +### PriceListType + +Re-exports [PriceListType](../enums/internal-3.PriceListType.md) + +___ + +### Product + +Re-exports [Product](../classes/internal-3.Product.md) + +___ + +### ProductCategory + +Re-exports [ProductCategory](../classes/internal-3.ProductCategory.md) + +___ + +### ProductCollection + +Re-exports [ProductCollection](../classes/internal-3.ProductCollection.md) + +___ + +### ProductOption + +Re-exports [ProductOption](../classes/internal-3.ProductOption.md) + +___ + +### ProductOptionValue + +Re-exports [ProductOptionValue](../classes/internal-3.ProductOptionValue.md) + +___ + +### ProductStatus + +Re-exports [ProductStatus](../enums/internal-3.ProductStatus.md) + +___ + +### ProductTag + +Re-exports [ProductTag](../classes/internal-3.ProductTag.md) + +___ + +### ProductType + +Re-exports [ProductType](../classes/internal-3.ProductType.md) + +___ + +### ProductVariant + +Re-exports [ProductVariant](../classes/internal-3.ProductVariant.md) + +___ + +### ProductVariantInventoryItem + +Re-exports [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md) + +___ + +### Refund + +Re-exports [Refund](../classes/internal-3.Refund.md) + +___ + +### Region + +Re-exports [Region](../classes/internal-3.Region.md) + +___ + +### RequirementType + +Re-exports [RequirementType](../enums/internal-3.RequirementType.md) + +___ + +### Return + +Re-exports [Return](../classes/internal-3.Return.md) + +___ + +### ReturnItem + +Re-exports [ReturnItem](../classes/internal-3.ReturnItem.md) + +___ + +### ReturnReason + +Re-exports [ReturnReason](../classes/internal-3.ReturnReason.md) + +___ + +### ReturnStatus + +Re-exports [ReturnStatus](../enums/internal-3.ReturnStatus.md) + +___ + +### SalesChannel + +Re-exports [SalesChannel](../classes/internal-3.SalesChannel.md) + +___ + +### SalesChannelLocation + +Re-exports [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md) + +___ + +### ShippingMethod + +Re-exports [ShippingMethod](../classes/internal-3.ShippingMethod.md) + +___ + +### ShippingMethodTaxLine + +Re-exports [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md) + +___ + +### ShippingOption + +Re-exports [ShippingOption](../classes/internal-3.ShippingOption.md) + +___ + +### ShippingOptionPriceType + +Re-exports [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md) + +___ + +### ShippingOptionRequirement + +Re-exports [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md) + +___ + +### ShippingProfile + +Re-exports [ShippingProfile](../classes/internal-3.ShippingProfile.md) + +___ + +### ShippingProfileType + +Re-exports [ShippingProfileType](../enums/internal-3.ShippingProfileType.md) + +___ + +### SoftDeletableEntity + +Re-exports [SoftDeletableEntity](../classes/internal-1.SoftDeletableEntity.md) + +___ + +### StorePostCustomersCustomerAddressesAddressReq + +Re-exports [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md) + +___ + +### StorePostCustomersCustomerAddressesReq + +Re-exports [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md) + +___ + +### StringComparisonOperator + +Re-exports [StringComparisonOperator](../classes/internal-6.StringComparisonOperator.md) + +___ + +### Swap + +Re-exports [Swap](../classes/internal-3.Swap.md) + +___ + +### SwapFulfillmentStatus + +Re-exports [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md) + +___ + +### SwapPaymentStatus + +Re-exports [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md) + +___ + +### TaxProvider + +Re-exports [TaxProvider](../classes/internal-3.TaxProvider.md) + +___ + +### TaxRate + +Re-exports [TaxRate](../classes/internal-3.TaxRate.md) + +___ + +### TrackingLink + +Re-exports [TrackingLink](../classes/internal-3.TrackingLink.md) + +___ + +### User + +Re-exports [User](../classes/internal-1.User.md) + +___ + +### UserRoles + +Re-exports [UserRoles](../enums/internal-1.UserRoles.md) + +## Type Aliases + +### AdminAnalyticsConfigDeleteRes + +Ƭ **AdminAnalyticsConfigDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:9 + +___ + +### AdminAnalyticsConfigRes + +Ƭ **AdminAnalyticsConfigRes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `analytics_config` | [`AnalyticsConfig`](../classes/internal-8.internal.AnalyticsConfig.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/analytics-configs/index.d.ts:6 + +___ + +### AdminCollectionsDeleteRes + +Ƭ **AdminCollectionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminCollectionsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Collection + object: + type: string + description: The type of the object that was deleted. + default: product-collection + deleted: + type: boolean + description: Whether the collection was deleted successfully or not. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/index.d.ts:55 + +___ + +### AdminCustomerGroupsDeleteRes + +Ƭ **AdminCustomerGroupsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminCustomerGroupsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted customer group. + object: + type: string + description: The type of the object that was deleted. + default: customer_group + deleted: + type: boolean + description: Whether the customer group was deleted successfully or not. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:38 + +___ + +### AdminDeleteShippingProfileRes + +Ƭ **AdminDeleteShippingProfileRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminDeleteShippingProfileRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Shipping Profile. + object: + type: string + description: The type of the object that was deleted. + default: shipping_profile + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:28 + +___ + +### AdminDeleteUploadsRes + +Ƭ **AdminDeleteUploadsRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminDeleteUploadsRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The file key of the upload deleted + object: + type: string + description: The type of the object that was deleted. + default: file + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/index.d.ts:51 + +___ + +### AdminDeleteUserRes + +Ƭ **AdminDeleteUserRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminDeleteUserRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted user. + object: + type: string + description: The type of the object that was deleted. + default: user + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/index.d.ts:54 + +___ + +### AdminDiscountConditionsDeleteRes + +Ƭ **AdminDiscountConditionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) & { `discount`: [`Discount`](../classes/internal-3.Discount.md) } + +**`Schema`** + +AdminDiscountConditionsDeleteRes +type: object +required: + - id + - object + - deleted + - discount +properties: + id: + type: string + description: The ID of the deleted Discount Condition + object: + type: string + description: The type of the object that was deleted. + default: discount-condition + deleted: + type: boolean + description: Whether the discount condition was deleted successfully. + default: true + discount: + description: The Discount to which the condition used to belong to. + $ref: "#/components/schemas/Discount" + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:96 + +___ + +### AdminDiscountsDeleteRes + +Ƭ **AdminDiscountsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminDiscountsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Discount + object: + type: string + description: The type of the object that was deleted. + default: discount + deleted: + type: boolean + description: Whether the discount was deleted successfully. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:71 + +___ + +### AdminDraftOrdersDeleteRes + +Ƭ **AdminDraftOrdersDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminDraftOrdersDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Draft Order. + object: + type: string + description: The type of the object that was deleted. + default: draft-order + deleted: + type: boolean + description: Whether the draft order was deleted successfully. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:114 + +___ + +### AdminDraftOrdersListRes + +Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal-3.DraftOrder.md)[] } + +**`Schema`** + +AdminDraftOrdersListRes +type: object +x-expanded-relations: + field: draft_orders + relations: + - order + - cart + - cart.items + - cart.items.adjustments +required: + - draft_orders + - count + - offset + - limit +properties: + draft_orders: + type: array + description: An array of draft order's details. + items: + $ref: "#/components/schemas/DraftOrder" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of draft orders skipped when retrieving the draft orders. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:146 + +___ + +### AdminDraftOrdersRes + +Ƭ **AdminDraftOrdersRes**: `Object` + +**`Schema`** + +AdminDraftOrdersRes +type: object +x-expanded-relations: + field: draft_order + relations: + - order + - cart + - cart.items + - cart.items.adjustments + - cart.billing_address + - cart.customer + - cart.discounts + - cart.discounts.rule + - cart.items + - cart.items.adjustments + - cart.payment + - cart.payment_sessions + - cart.region + - cart.region.payment_providers + - cart.shipping_address + - cart.shipping_methods + - cart.shipping_methods.shipping_option + eager: + - cart.region.fulfillment_providers + - cart.region.payment_providers + - cart.shipping_methods.shipping_option + implicit: + - cart.discounts + - cart.discounts.rule + - cart.gift_cards + - cart.items + - cart.items.adjustments + - cart.items.tax_lines + - cart.items.variant + - cart.items.variant.product + - cart.items.variant.product.profiles + - cart.region + - cart.region.tax_rates + - cart.shipping_address + - cart.shipping_methods + - cart.shipping_methods.tax_lines + totals: + - cart.discount_total + - cart.gift_card_tax_total + - cart.gift_card_total + - cart.item_tax_total + - cart.refundable_amount + - cart.refunded_total + - cart.shipping_tax_total + - cart.shipping_total + - cart.subtotal + - cart.tax_total + - cart.total + - cart.items.discount_total + - cart.items.gift_card_total + - cart.items.original_tax_total + - cart.items.original_total + - cart.items.refundable + - cart.items.subtotal + - cart.items.tax_total + - cart.items.total +required: + - draft_order +properties: + draft_order: + description: Draft order's details. + $ref: "#/components/schemas/DraftOrder" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `draft_order` | [`DraftOrder`](../classes/internal-3.DraftOrder.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:91 + +___ + +### AdminExtendedStoresRes + +Ƭ **AdminExtendedStoresRes**: `Object` + +**`Schema`** + +AdminExtendedStoresRes +type: object +x-expanded-relations: + field: store + relations: + - currencies + - default_currency +required: + - store +properties: + store: + description: Store details. + $ref: "#/components/schemas/ExtendedStoreDTO" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `store` | [`ExtendedStoreDTO`](internal-8.md#extendedstoredto) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/index.d.ts:21 + +___ + +### AdminGetVariantsVariantInventoryRes + +Ƭ **AdminGetVariantsVariantInventoryRes**: `Object` + +**`Schema`** + +AdminGetVariantsVariantInventoryRes +type: object +properties: + variant: + type: object + description: "The product variant's." + $ref: "#/components/schemas/VariantInventory" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variant` | [`VariantInventory`](internal-8.internal.md#variantinventory) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:134 + +___ + +### AdminGiftCardsDeleteRes + +Ƭ **AdminGiftCardsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminGiftCardsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Gift Card + object: + type: string + description: The type of the object that was deleted. + default: gift-card + deleted: + type: boolean + description: Whether the gift card was deleted successfully. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:49 + +___ + +### AdminGiftCardsListRes + +Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal-3.GiftCard.md)[] } + +**`Schema`** + +AdminGiftCardsListRes +type: object +x-expanded-relations: + field: gift_cards + relations: + - order + - region + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - gift_cards + - count + - offset + - limit +properties: + gift_cards: + type: array + items: + $ref: "#/components/schemas/GiftCard" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of gift cards skipped when retrieving the gift cards. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:81 + +___ + +### AdminGiftCardsRes + +Ƭ **AdminGiftCardsRes**: `Object` + +**`Schema`** + +AdminGiftCardsRes +type: object +x-expanded-relations: + field: gift_card + relations: + - order + - region + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - gift_card +properties: + gift_card: + description: "A gift card's details." + $ref: "#/components/schemas/GiftCard" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:26 + +___ + +### AdminInventoryItemsDeleteRes + +Ƭ **AdminInventoryItemsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminInventoryItemsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Inventory Item. + object: + type: string + description: The type of the object that was deleted. + format: inventory_item + deleted: + type: boolean + description: Whether or not the Inventory Item was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:43 + +___ + +### AdminInventoryItemsListRes + +Ƭ **AdminInventoryItemsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `inventory_items`: [`InventoryItemDTO`](internal-8.md#inventoryitemdto)[] } + +**`Schema`** + +AdminInventoryItemsListRes +type: object +required: + - inventory_items + - count + - offset + - limit +properties: + inventory_items: + type: array + description: an array of Inventory Item details + items: + $ref: "#/components/schemas/InventoryItemDTO" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of inventory items skipped when retrieving the inventory items. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:68 + +___ + +### AdminInventoryItemsListWithVariantsAndLocationLevelsRes + +Ƭ **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](internal-8.internal.md#decoratedinventoryitemdto)[] } + +**`Schema`** + +AdminInventoryItemsListWithVariantsAndLocationLevelsRes +type: object +required: + - inventory_items + - count + - offset + - limit +properties: + inventory_items: + type: array + description: an array of Inventory Item details + items: + $ref: "#/components/schemas/DecoratedInventoryItemDTO" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of inventory items skipped when retrieving the inventory items. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:128 + +___ + +### AdminInventoryItemsLocationLevelsRes + +Ƭ **AdminInventoryItemsLocationLevelsRes**: `Object` + +**`Schema`** + +AdminInventoryItemsLocationLevelsRes +type: object +required: + - inventory_item +properties: + inventory_item: + type: object + required: + - id + - location_levels + properties: + id: + description: The id of the location + location_levels: + description: List of stock levels at a given location + type: array + items: + $ref: "#/components/schemas/InventoryLevelDTO" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `inventory_item` | { `id`: `any` ; `location_levels`: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] } | +| `inventory_item.id` | `any` | +| `inventory_item.location_levels` | [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:151 + +___ + +### AdminInventoryItemsRes + +Ƭ **AdminInventoryItemsRes**: `Object` + +**`Schema`** + +AdminInventoryItemsRes +type: object +required: + - inventory_item +properties: + inventory_item: + description: Inventory Item details + $ref: "#/components/schemas/InventoryItemDTO" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `inventory_item` | [`InventoryItemDTO`](internal-8.md#inventoryitemdto) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:20 + +___ + +### AdminInviteDeleteRes + +Ƭ **AdminInviteDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminInviteDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Invite. + object: + type: string + description: The type of the object that was deleted. + default: invite + deleted: + type: boolean + description: Whether or not the invite was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/index.d.ts:27 + +___ + +### AdminListInvitesRes + +Ƭ **AdminListInvitesRes**: `Object` + +**`Schema`** + +AdminListInvitesRes +type: object +required: + - invites +properties: + invites: + type: array + description: An array of invites + items: + $ref: "#/components/schemas/Invite" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `invites` | [`Invite`](../classes/internal-8.internal.Invite.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/index.d.ts:40 + +___ + +### AdminNotesDeleteRes + +Ƭ **AdminNotesDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminNotesDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Note. + object: + type: string + description: The type of the object that was deleted. + default: note + deleted: + type: boolean + description: Whether or not the Note was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/index.d.ts:39 + +___ + +### AdminNotesListRes + +Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-8.internal.Note.md)[] } + +**`Schema`** + +AdminNotesListRes +type: object +required: + - notes + - count + - offset + - limit +properties: + notes: + type: array + description: An array of notes + items: + $ref: "#/components/schemas/Note" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of notes skipped when retrieving the notes. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/index.d.ts:64 + +___ + +### AdminNotesRes + +Ƭ **AdminNotesRes**: `Object` + +**`Schema`** + +AdminNotesRes +type: object +required: + - note +properties: + note: + description: Note details. + $ref: "#/components/schemas/Note" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `note` | [`Note`](../classes/internal-8.internal.Note.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/notes/index.d.ts:16 + +___ + +### AdminNotificationsListRes + +Ƭ **AdminNotificationsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `notifications`: [`Notification`](../classes/internal-8.internal.Notification.md)[] } + +**`Schema`** + +AdminNotificationsListRes +type: object +x-expanded-relations: + field: notifications + relations: + - resends +required: + - notifications +properties: + notifications: + type: array + description: an array of notifications + items: + $ref: "#/components/schemas/Notification" + count: + type: integer + description: The total number of notifications + offset: + type: integer + description: The number of notifications skipped when retrieving the notifications. + limit: + type: integer + description: The number of notifications per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/index.d.ts:32 + +___ + +### AdminNotificationsRes + +Ƭ **AdminNotificationsRes**: `Object` + +**`Schema`** + +AdminNotificationsRes +type: object +x-expanded-relations: + field: notification + relations: + - resends +required: + - notification +properties: + notification: + description: Notification details + $ref: "#/components/schemas/Notification" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `notification` | [`Notification`](../classes/internal-8.internal.Notification.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/index.d.ts:49 + +___ + +### AdminOrderEditDeleteRes + +Ƭ **AdminOrderEditDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminOrderEditDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Order Edit. + object: + type: string + description: The type of the object that was deleted. + default: order_edit + deleted: + type: boolean + description: Whether or not the Order Edit was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:135 + +___ + +### AdminOrderEditItemChangeDeleteRes + +Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object` + +**`Schema`** + +AdminOrderEditItemChangeDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Order Edit Item Change. + object: + type: string + description: The type of the object that was deleted. + default: item_change + deleted: + type: boolean + description: Whether or not the Order Edit Item Change was deleted. + default: true + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | ``"item_change"`` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:156 + +___ + +### AdminOrderEditsListRes + +Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal-3.OrderEdit.md)[] } + +**`Schema`** + +AdminOrderEditsListRes +type: object +x-expanded-relations: + field: order_edits + relations: + - changes + - changes.line_item + - changes.line_item.variant + - changes.original_line_item + - changes.original_line_item.variant + - items + - items.adjustments + - items.tax_lines + - items.variant + - payment_collection + implicit: + - items + - items.tax_lines + - items.adjustments + - items.variant + totals: + - difference_due + - discount_total + - gift_card_tax_total + - gift_card_total + - shipping_total + - subtotal + - tax_total + - total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total +required: + - order_edits + - count + - offset + - limit +properties: + order_edits: + type: array + description: "An array of order edit details" + items: + $ref: "#/components/schemas/OrderEdit" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of order edits skipped when retrieving the order edits. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:112 + +___ + +### AdminOrderEditsRes + +Ƭ **AdminOrderEditsRes**: `Object` + +**`Schema`** + +AdminOrderEditsRes +type: object +x-expanded-relations: + field: order_edit + relations: + - changes + - changes.line_item + - changes.line_item.variant + - changes.original_line_item + - changes.original_line_item.variant + - items + - items.adjustments + - items.tax_lines + - items.variant + - payment_collection + implicit: + - items + - items.tax_lines + - items.adjustments + - items.variant + totals: + - difference_due + - discount_total + - gift_card_tax_total + - gift_card_total + - shipping_total + - subtotal + - tax_total + - total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total +required: + - order_edit +properties: + order_edit: + description: "Order edit details" + $ref: "#/components/schemas/OrderEdit" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order_edit` | [`OrderEdit`](../classes/internal-3.OrderEdit.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/index.d.ts:50 + +___ + +### AdminOrdersListRes + +Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal-3.Order.md)[] } + +**`Schema`** + +AdminOrdersListRes +type: object +x-expanded-relations: + field: orders + relations: + - billing_address + - claims + - claims.additional_items + - claims.additional_items.variant + - claims.claim_items + - claims.claim_items.images + - claims.claim_items.item + - claims.fulfillments + - claims.fulfillments.tracking_links + - claims.return_order + - claims.return_order.shipping_method + - claims.return_order.shipping_method.tax_lines + - claims.shipping_address + - claims.shipping_methods + - customer + - discounts + - discounts.rule + - fulfillments + - fulfillments.items + - fulfillments.tracking_links + - gift_card_transactions + - gift_cards + - items + - payments + - refunds + - region + - returns + - returns.items + - returns.items.reason + - returns.shipping_method + - returns.shipping_method.tax_lines + - shipping_address + - shipping_methods + eager: + - fulfillments.items + - region.fulfillment_providers + - region.payment_providers + - returns.items + - shipping_methods.shipping_option + implicit: + - claims + - claims.additional_items + - claims.additional_items.adjustments + - claims.additional_items.refundable + - claims.additional_items.tax_lines + - discounts + - discounts.rule + - gift_card_transactions + - gift_card_transactions.gift_card + - gift_cards + - items + - items.adjustments + - items.refundable + - items.tax_lines + - items.variant + - items.variant.product + - items.variant.product.profiles + - refunds + - region + - shipping_methods + - shipping_methods.tax_lines + - swaps + - swaps.additional_items + - swaps.additional_items.adjustments + - swaps.additional_items.refundable + - swaps.additional_items.tax_lines + totals: + - discount_total + - gift_card_tax_total + - gift_card_total + - paid_total + - refundable_amount + - refunded_total + - shipping_total + - subtotal + - tax_total + - total + - claims.additional_items.discount_total + - claims.additional_items.gift_card_total + - claims.additional_items.original_tax_total + - claims.additional_items.original_total + - claims.additional_items.refundable + - claims.additional_items.subtotal + - claims.additional_items.tax_total + - claims.additional_items.total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total + - swaps.additional_items.discount_total + - swaps.additional_items.gift_card_total + - swaps.additional_items.original_tax_total + - swaps.additional_items.original_total + - swaps.additional_items.refundable + - swaps.additional_items.subtotal + - swaps.additional_items.tax_total + - swaps.additional_items.total +required: + - orders + - count + - offset + - limit +properties: + orders: + type: array + description: "An array of order details." + items: + $ref: "#/components/schemas/Order" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of orders skipped when retrieving the orders. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/index.d.ts:252 + +___ + +### AdminOrdersRes + +Ƭ **AdminOrdersRes**: `Object` + +**`Schema`** + +AdminOrdersRes +type: object +x-expanded-relations: + field: order + relations: + - billing_address + - claims + - claims.additional_items + - claims.additional_items.variant + - claims.claim_items + - claims.claim_items.images + - claims.claim_items.item + - claims.fulfillments + - claims.fulfillments.tracking_links + - claims.return_order + - claims.return_order.shipping_method + - claims.return_order.shipping_method.tax_lines + - claims.shipping_address + - claims.shipping_methods + - customer + - discounts + - discounts.rule + - fulfillments + - fulfillments.items + - fulfillments.tracking_links + - gift_card_transactions + - gift_cards + - items + - payments + - refunds + - region + - returns + - returns.items + - returns.items.reason + - returns.shipping_method + - returns.shipping_method.tax_lines + - shipping_address + - shipping_methods + eager: + - fulfillments.items + - region.fulfillment_providers + - region.payment_providers + - returns.items + - shipping_methods.shipping_option + implicit: + - claims + - claims.additional_items + - claims.additional_items.adjustments + - claims.additional_items.refundable + - claims.additional_items.tax_lines + - discounts + - discounts.rule + - gift_card_transactions + - gift_card_transactions.gift_card + - gift_cards + - items + - items.adjustments + - items.refundable + - items.tax_lines + - items.variant + - items.variant.product + - items.variant.product.profiles + - refunds + - region + - shipping_methods + - shipping_methods.tax_lines + - swaps + - swaps.additional_items + - swaps.additional_items.adjustments + - swaps.additional_items.refundable + - swaps.additional_items.tax_lines + totals: + - discount_total + - gift_card_tax_total + - gift_card_total + - paid_total + - refundable_amount + - refunded_total + - shipping_total + - subtotal + - tax_total + - total + - claims.additional_items.discount_total + - claims.additional_items.gift_card_total + - claims.additional_items.original_tax_total + - claims.additional_items.original_total + - claims.additional_items.refundable + - claims.additional_items.subtotal + - claims.additional_items.tax_total + - claims.additional_items.total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total + - swaps.additional_items.discount_total + - swaps.additional_items.gift_card_total + - swaps.additional_items.original_tax_total + - swaps.additional_items.original_total + - swaps.additional_items.refundable + - swaps.additional_items.subtotal + - swaps.additional_items.tax_total + - swaps.additional_items.total +required: + - order +properties: + order: + description: "Order details." + $ref: "#/components/schemas/Order" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal-3.Order.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/index.d.ts:121 + +___ + +### AdminPaymentCollectionDeleteRes + +Ƭ **AdminPaymentCollectionDeleteRes**: `Object` + +**`Schema`** + +AdminPaymentCollectionDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Payment Collection. + object: + type: string + description: The type of the object that was deleted. + default: payment_collection + deleted: + type: boolean + description: Whether or not the Payment Collection was deleted. + default: true + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | ``"payment_collection"`` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:49 + +___ + +### AdminPaymentCollectionsRes + +Ƭ **AdminPaymentCollectionsRes**: `Object` + +**`Schema`** + +AdminPaymentCollectionsRes +type: object +x-expanded-relations: + field: payment_collection + relations: + - payment_sessions + - payments + - region + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - payment_collection +properties: + payment_collection: + description: Payment Collection details. + $ref: "#/components/schemas/PaymentCollection" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_collection` | [`PaymentCollection`](../classes/internal-3.PaymentCollection.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:26 + +___ + +### AdminPaymentProvidersList + +Ƭ **AdminPaymentProvidersList**: `Object` + +**`Schema`** + +AdminPaymentProvidersList +type: object +required: + - payment_providers +properties: + payment_providers: + type: array + description: An array of payment providers details. + items: + $ref: "#/components/schemas/PaymentProvider" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_providers` | [`PaymentProvider`](../classes/internal-3.PaymentProvider.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/index.d.ts:64 + +___ + +### AdminPaymentRes + +Ƭ **AdminPaymentRes**: `Object` + +**`Schema`** + +AdminPaymentRes +type: object +required: + - payment +properties: + payment: + description: "Payment details" + $ref: "#/components/schemas/Payment" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment` | [`Payment`](../classes/internal-3.Payment.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/index.d.ts:16 + +___ + +### AdminPostDraftOrdersDraftOrderRegisterPaymentRes + +Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` + +**`Schema`** + +AdminPostDraftOrdersDraftOrderRegisterPaymentRes +type: object +required: + - order +properties: + order: + description: Order's details. + $ref: "#/components/schemas/Order" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal-3.Order.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:19 + +___ + +### AdminPriceListDeleteBatchRes + +Ƭ **AdminPriceListDeleteBatchRes**: `Object` + +**`Schema`** + +AdminPriceListDeleteBatchRes +type: object +required: + - ids + - object + - deleted +properties: + ids: + type: array + items: + type: string + description: The IDs of the deleted prices. + object: + type: string + description: The type of the object that was deleted. A price is also named `money-amount`. + default: money-amount + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `ids` | `string`[] | +| `object` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:49 + +___ + +### AdminPriceListDeleteProductPricesRes + +Ƭ **AdminPriceListDeleteProductPricesRes**: [`AdminPriceListDeleteBatchRes`](internal-8.internal.md#adminpricelistdeletebatchres) + +**`Schema`** + +AdminPriceListDeleteProductPricesRes +type: object +required: + - ids + - object + - deleted +properties: + ids: + type: array + description: The IDs of the deleted prices. + items: + type: string + object: + type: string + description: The type of the object that was deleted. A price is also named `money-amount`. + default: money-amount + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:76 + +___ + +### AdminPriceListDeleteRes + +Ƭ **AdminPriceListDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminPriceListDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Price List. + object: + type: string + description: The type of the object that was deleted. + default: price-list + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:120 + +___ + +### AdminPriceListDeleteVariantPricesRes + +Ƭ **AdminPriceListDeleteVariantPricesRes**: [`AdminPriceListDeleteBatchRes`](internal-8.internal.md#adminpricelistdeletebatchres) + +**`Schema`** + +AdminPriceListDeleteVariantPricesRes +type: object +required: + - ids + - object + - deleted +properties: + ids: + type: array + description: The IDs of the deleted prices. + items: + type: string + object: + type: string + description: The type of the object that was deleted. A price is also named `money-amount`. + default: money-amount + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:99 + +___ + +### AdminPriceListRes + +Ƭ **AdminPriceListRes**: `Object` + +**`Schema`** + +AdminPriceListRes +type: object +x-expanded-relations: + field: price_list + relations: + - customer_groups + - prices +required: + - price_list +properties: + price_list: + description: "Price List details." + $ref: "#/components/schemas/PriceList" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `price_list` | [`PriceList`](../classes/internal-3.PriceList.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:24 + +___ + +### AdminPriceListsListRes + +Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal-3.PriceList.md)[] } + +**`Schema`** + +AdminPriceListsListRes +type: object +required: + - price_lists + - count + - offset + - limit +properties: + price_lists: + type: array + description: "An array of price lists details." + items: + $ref: "#/components/schemas/PriceList" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of price lists skipped when retrieving the price lists. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:145 + +___ + +### AdminPriceListsProductsListRes + +Ƭ **AdminPriceListsProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal-3.Product.md)[] } + +**`Schema`** + +AdminPriceListsProductsListRes +type: object +x-expanded-relations: + field: products + relations: + - categories + - collection + - images + - options + - tags + - type + - variants + - variants.options +required: + - products + - count + - offset + - limit +properties: + products: + type: array + description: "An array of products details." + items: + $ref: "#/components/schemas/Product" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of price lists skipped when retrieving the price lists. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:183 + +___ + +### AdminProductCategoriesCategoryDeleteRes + +Ƭ **AdminProductCategoriesCategoryDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminProductCategoriesCategoryDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted product category + object: + type: string + description: The type of the object that was deleted. + default: product-category + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:53 + +___ + +### AdminProductCategoriesCategoryRes + +Ƭ **AdminProductCategoriesCategoryRes**: `Object` + +**`Schema`** + +AdminProductCategoriesCategoryRes +type: object +x-expanded-relations: + field: product_category + relations: + - category_children + - parent_category +required: + - product_category +properties: + product_category: + description: "Product category details." + $ref: "#/components/schemas/ProductCategory" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product_category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:30 + +___ + +### AdminProductCategoriesListRes + +Ƭ **AdminProductCategoriesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)[] } + +**`Schema`** + +AdminProductCategoriesListRes +type: object +x-expanded-relations: + field: product_categories + relations: + - category_children + - parent_category +required: + - product_categories + - count + - offset + - limit +properties: + product_categories: + type: array + description: "An array of product category details." + items: + $ref: "#/components/schemas/ProductCategory" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product categories skipped when retrieving the product categories. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:83 + +___ + +### AdminProductTagsListRes + +Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal-3.ProductTag.md)[] } + +**`Schema`** + +AdminProductTagsListRes +type: object +required: + - product_tags + - count + - offset + - limit +properties: + product_tags: + type: array + description: "An array of product tag details." + items: + $ref: "#/components/schemas/ProductTag" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product tags skipped when retrieving the product tags. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:32 + +___ + +### AdminProductTypesListRes + +Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal-3.ProductType.md)[] } + +**`Schema`** + +AdminProductTypesListRes +type: object +required: + - product_types + - count + - offset + - limit +properties: + product_types: + type: array + description: An array of product types details. + items: + $ref: "#/components/schemas/ProductType" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product types skipped when retrieving the product types. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/index.d.ts:32 + +___ + +### AdminProductsDeleteOptionRes + +Ƭ **AdminProductsDeleteOptionRes**: `Object` + +**`Schema`** + +AdminProductsDeleteOptionRes +type: object +x-expanded-relations: + field: product + relations: + - collection + - images + - options + - tags + - type + - variants + - variants.options + - variants.prices +required: + - option_id + - object + - deleted + - product +properties: + option_id: + type: string + description: The ID of the deleted Product Option + object: + type: string + description: The type of the object that was deleted. + default: option + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + product: + description: Product details. + $ref: "#/components/schemas/PricedProduct" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `object` | ``"option"`` | +| `option_id` | `string` | +| `product` | [`Product`](../classes/internal-3.Product.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:79 + +___ + +### AdminProductsDeleteRes + +Ƭ **AdminProductsDeleteRes**: `Object` + +**`Schema`** + +AdminProductsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Product. + object: + type: string + description: The type of the object that was deleted. + default: product + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | ``"product"`` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:146 + +___ + +### AdminProductsDeleteVariantRes + +Ƭ **AdminProductsDeleteVariantRes**: `Object` + +**`Schema`** + +AdminProductsDeleteVariantRes +type: object +x-expanded-relations: + field: product + relations: + - collection + - images + - options + - tags + - type + - variants + - variants.options + - variants.prices +required: + - variant_id + - object + - deleted + - product +properties: + variant_id: + type: string + description: The ID of the deleted Product Variant. + object: + type: string + description: The type of the object that was deleted. + default: product-variant + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + product: + description: Product details. + $ref: "#/components/schemas/PricedProduct" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `object` | ``"product-variant"`` | +| `product` | [`Product`](../classes/internal-3.Product.md) | +| `variant_id` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:120 + +___ + +### AdminProductsListRes + +Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-8.md#pricedproduct) \| [`Product`](../classes/internal-3.Product.md))[] } + +**`Schema`** + +AdminProductsListRes +type: object +x-expanded-relations: + field: products + relations: + - collection + - images + - options + - tags + - type + - variants + - variants.options + - variants.prices + totals: + - variants.purchasable +required: + - products + - count + - offset + - limit +properties: + products: + type: array + description: An array of products details. + items: + $ref: "#/components/schemas/PricedProduct" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of products skipped when retrieving the products. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:188 + +___ + +### AdminProductsListTagsRes + +Ƭ **AdminProductsListTagsRes**: `Object` + +**`Schema`** + +AdminProductsListTagsRes +type: object +required: + - tags +properties: + tags: + description: An array of product tags details. + type: array + items: + type: object + required: + - id + - usage_count + - value + properties: + id: + description: The ID of the tag. + type: string + usage_count: + description: The number of products that use this tag. + type: string + value: + description: The value of the tag. + type: string + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tags` | [`Pick`](internal-1.md#pick)<[`ProductTag`](../classes/internal-3.ProductTag.md), ``"id"`` \| ``"value"``\> & { `usage_count`: `number` }[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:259 + +___ + +### AdminProductsListTypesRes + +Ƭ **AdminProductsListTypesRes**: `Object` + +**`Schema`** + +AdminProductsListTypesRes +type: object +required: + - types +properties: + types: + type: array + description: An array of product types details. + items: + $ref: "#/components/schemas/ProductType" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `types` | [`ProductType`](../classes/internal-3.ProductType.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:230 + +___ + +### AdminProductsListVariantsRes + +Ƭ **AdminProductsListVariantsRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] } + +**`Schema`** + +AdminProductsListVariantsRes +type: object +required: + - variants + - count + - offset + - limit +properties: + variants: + type: array + description: An array of product variants details. + items: + $ref: "#/components/schemas/ProductVariant" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product variants skipped when retrieving the product variants. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:215 + +___ + +### AdminProductsRes + +Ƭ **AdminProductsRes**: `Object` + +**`Schema`** + +AdminProductsRes +type: object +x-expanded-relations: + field: product + relations: + - collection + - images + - options + - tags + - type + - variants + - variants.options + - variants.prices +required: + - product +properties: + product: + description: Product details. + $ref: "#/components/schemas/PricedProduct" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`Product`](../classes/internal-3.Product.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:285 + +___ + +### AdminPublishableApiKeyDeleteRes + +Ƭ **AdminPublishableApiKeyDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminPublishableApiKeyDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted publishable API key. + object: + type: string + description: The type of the object that was deleted. + default: publishable_api_key + deleted: + type: boolean + description: Whether the publishable API key was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:65 + +___ + +### AdminPublishableApiKeysListRes + +Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-8.internal.PublishableApiKey.md)[] } + +**`Schema`** + +AdminPublishableApiKeysListRes +type: object +required: + - publishable_api_keys + - count + - offset + - limit +properties: + publishable_api_keys: + type: array + description: "An array of publishable API keys details." + items: + $ref: "#/components/schemas/PublishableApiKey" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of publishable API keys skipped when retrieving the publishable API keys. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:42 + +___ + +### AdminPublishableApiKeysListSalesChannelsRes + +Ƭ **AdminPublishableApiKeysListSalesChannelsRes**: `Object` + +**`Schema`** + +AdminPublishableApiKeysListSalesChannelsRes +type: object +required: + - sales_channels +properties: + sales_channels: + description: "An array of sales channels details." + type: array + items: + $ref: "#/components/schemas/SalesChannel" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `sales_channels` | [`SalesChannel`](../classes/internal-3.SalesChannel.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:78 + +___ + +### AdminPublishableApiKeysRes + +Ƭ **AdminPublishableApiKeysRes**: `Object` + +**`Schema`** + +AdminPublishableApiKeysRes +type: object +required: + - publishable_api_key +properties: + publishable_api_key: + description: "Publishable API key details." + $ref: "#/components/schemas/PublishableApiKey" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-8.internal.PublishableApiKey.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:15 + +___ + +### AdminRefundRes + +Ƭ **AdminRefundRes**: `Object` + +**`Schema`** + +AdminRefundRes +type: object +required: + - refund +properties: + refund: + description: "Refund details" + $ref: "#/components/schemas/Refund" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `refund` | [`Refund`](../classes/internal-3.Refund.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/index.d.ts:29 + +___ + +### AdminRegionsDeleteRes + +Ƭ **AdminRegionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminRegionsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Region. + object: + type: string + description: The type of the object that was deleted. + default: region + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:87 + +___ + +### AdminRegionsListRes + +Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal-3.Region.md)[] } + +**`Schema`** + +AdminRegionsListRes +type: object +x-expanded-relations: + field: regions + relations: + - countries + - fulfillment_providers + - payment_providers + eager: + - fulfillment_providers + - payment_providers +required: + - regions + - count + - offset + - limit +properties: + regions: + type: array + description: "An array of regions details." + items: + $ref: "#/components/schemas/Region" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of regions skipped when retrieving the regions. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:64 + +___ + +### AdminReservationsDeleteRes + +Ƭ **AdminReservationsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminReservationsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Reservation. + object: + type: string + description: The type of the object that was deleted. + default: reservation + deleted: + type: boolean + description: Whether or not the Reservation was deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:86 + +___ + +### AdminReservationsListRes + +Ƭ **AdminReservationsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](internal-8.md#reservationitemdto)[] } + +**`Schema`** + +AdminReservationsListRes +type: object +required: + - reservations + - count + - offset + - limit +properties: + reservations: + type: array + description: An array of reservations details. + items: + $ref: "#/components/schemas/ExtendedReservationItem" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of reservations skipped when retrieving the reservations. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:61 + +___ + +### AdminReservationsRes + +Ƭ **AdminReservationsRes**: `Object` + +**`Schema`** + +AdminReservationsRes +type: object +required: + - reservation +properties: + reservation: + description: Reservation details. + $ref: "#/components/schemas/ReservationItemDTO" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `reservation` | [`ReservationItemDTO`](internal-8.md#reservationitemdto) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:16 + +___ + +### AdminReturnReasonsDeleteRes + +Ƭ **AdminReturnReasonsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminReturnReasonsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted return reason + object: + type: string + description: The type of the object that was deleted. + default: return_reason + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:63 + +___ + +### AdminReturnReasonsListRes + +Ƭ **AdminReturnReasonsListRes**: `Object` + +**`Schema`** + +AdminReturnReasonsListRes +type: object +x-expanded-relations: + field: return_reasons + relations: + - parent_return_reason + - return_reason_children +required: + - return_reasons +properties: + return_reasons: + type: array + items: + $ref: "#/components/schemas/ReturnReason" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reasons` | [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:40 + +___ + +### AdminReturnReasonsRes + +Ƭ **AdminReturnReasonsRes**: `Object` + +**`Schema`** + +AdminReturnReasonsRes +type: object +x-expanded-relations: + field: return_reason + relations: + - parent_return_reason + - return_reason_children +required: + - return_reason +properties: + return_reason: + $ref: "#/components/schemas/ReturnReason" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal-3.ReturnReason.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:21 + +___ + +### AdminReturnsCancelRes + +Ƭ **AdminReturnsCancelRes**: `Object` + +**`Schema`** + +AdminReturnsCancelRes +type: object +x-expanded-relations: + field: order + relations: + - billing_address + - claims + - claims.additional_items + - claims.additional_items.variant + - claims.claim_items + - claims.claim_items.images + - claims.claim_items.item + - claims.fulfillments + - claims.fulfillments.tracking_links + - claims.return_order + - claims.return_order.shipping_method + - claims.return_order.shipping_method.tax_lines + - claims.shipping_address + - claims.shipping_methods + - customer + - discounts + - discounts.rule + - fulfillments + - fulfillments.items + - fulfillments.tracking_links + - gift_card_transactions + - gift_cards + - items + - payments + - refunds + - region + - returns + - returns.items + - returns.items.reason + - returns.shipping_method + - returns.shipping_method.tax_lines + - shipping_address + - shipping_methods + - swaps + - swaps.additional_items + - swaps.additional_items.variant + - swaps.fulfillments + - swaps.fulfillments.tracking_links + - swaps.payment + - swaps.return_order + - swaps.return_order.shipping_method + - swaps.return_order.shipping_method.tax_lines + - swaps.shipping_address + - swaps.shipping_methods + - swaps.shipping_methods.tax_lines +required: + - order +properties: + order: + description: Order details. + $ref: "#/components/schemas/Order" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal-3.Order.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:68 + +___ + +### AdminReturnsListRes + +Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal-3.Return.md)[] } + +**`Schema`** + +AdminReturnsListRes +type: object +x-expanded-relation: + field: returns + relations: + - order + - swap +required: + - returns + - count + - offset + - limit +properties: + returns: + type: array + description: An array of returns details. + items: + $ref: "#/components/schemas/Return" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of returns skipped when retrieving the returns. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:100 + +___ + +### AdminReturnsRes + +Ƭ **AdminReturnsRes**: `Object` + +**`Schema`** + +AdminReturnsRes +type: object +x-expanded-relation: + field: return + relations: + - swap +required: + - return +properties: + return: + description: Return details. + $ref: "#/components/schemas/Return" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal-3.Return.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:117 + +___ + +### AdminSalesChannelsDeleteLocationRes + +Ƭ **AdminSalesChannelsDeleteLocationRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminSalesChannelsDeleteLocationRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the removed stock location from a sales channel + object: + type: string + description: The type of the object that was removed. + default: stock-location + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:60 + +___ + +### AdminSalesChannelsDeleteRes + +Ƭ **AdminSalesChannelsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminSalesChannelsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted sales channel + object: + type: string + description: The type of the object that was deleted. + default: sales-channel + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:39 + +___ + +### AdminSalesChannelsListRes + +Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal-3.SalesChannel.md)[] } + +**`Schema`** + +AdminSalesChannelsListRes +type: object +required: + - sales_channels + - count + - offset + - limit +properties: + sales_channels: + type: array + description: "An array of sales channels details." + items: + $ref: "#/components/schemas/SalesChannel" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of items skipped before the returned results + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:85 + +___ + +### AdminSalesChannelsRes + +Ƭ **AdminSalesChannelsRes**: `Object` + +**`Schema`** + +AdminSalesChannelsRes +type: object +required: + - sales_channel +properties: + sales_channel: + description: Sales Channel's details. + $ref: "#/components/schemas/SalesChannel" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `sales_channel` | [`SalesChannel`](../classes/internal-3.SalesChannel.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/index.d.ts:16 + +___ + +### AdminShippingOptionsDeleteRes + +Ƭ **AdminShippingOptionsDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminShippingOptionsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Shipping Option. + object: + type: string + description: The type of the object that was deleted. + default: shipping-option + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:86 + +___ + +### AdminShippingOptionsListRes + +Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal-3.ShippingOption.md)[] } + +**`Schema`** + +AdminShippingOptionsListRes +type: object +x-expanded-relations: + field: shipping_options + relations: + - profile + - region + - requirements + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - shipping_options + - count + - offset + - limit +properties: + shipping_options: + type: array + description: "An array of shipping options details." + items: + $ref: "#/components/schemas/ShippingOption" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of shipping options skipped when retrieving the shipping options. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:41 + +___ + +### AdminShippingOptionsRes + +Ƭ **AdminShippingOptionsRes**: `Object` + +**`Schema`** + +AdminShippingOptionsRes +type: object +x-expanded-relations: + field: shipping_option + relations: + - profile + - region + - requirements + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - shipping_option +properties: + shipping_option: + description: "Shipping option details." + $ref: "#/components/schemas/ShippingOption" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_option` | [`ShippingOption`](../classes/internal-3.ShippingOption.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:63 + +___ + +### AdminShippingProfilesListRes + +Ƭ **AdminShippingProfilesListRes**: `Object` + +**`Schema`** + +AdminShippingProfilesListRes +type: object +required: + - shipping_profiles +properties: + shipping_profiles: + type: array + description: An array of shipping profiles details. + items: + $ref: "#/components/schemas/ShippingProfile" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_profiles` | [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:59 + +___ + +### AdminShippingProfilesRes + +Ƭ **AdminShippingProfilesRes**: `Object` + +**`Schema`** + +AdminShippingProfilesRes +type: object +x-expanded-relations: + field: shipping_profile + relations: + - products + - shipping_options +required: + - shipping_profile +properties: + shipping_profile: + description: Shipping profile details. + $ref: "#/components/schemas/ShippingProfile" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_profile` | [`ShippingProfile`](../classes/internal-3.ShippingProfile.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:44 + +___ + +### AdminStockLocationsDeleteRes + +Ƭ **AdminStockLocationsDeleteRes**: [`DeleteResponse`](internal-8.md#deleteresponse) + +**`Schema`** + +AdminStockLocationsDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Stock Location. + object: + type: string + description: The type of the object that was deleted. + default: stock_location + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:26 + +___ + +### AdminStockLocationsListRes + +Ƭ **AdminStockLocationsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](internal-8.md#stocklocationexpandeddto)[] } + +**`Schema`** + +AdminStockLocationsListRes +type: object +required: + - stock_locations + - count + - offset + - limit +properties: + stock_locations: + type: array + items: + $ref: "#/components/schemas/StockLocationExpandedDTO" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of stock locations skipped when retrieving the stock locations. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:63 + +___ + +### AdminStockLocationsRes + +Ƭ **AdminStockLocationsRes**: `Object` + +**`Schema`** + +AdminStockLocationsRes +type: object +required: + - stock_location +properties: + stock_location: + description: "Stock location details." + $ref: "#/components/schemas/StockLocationExpandedDTO" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `stock_location` | [`StockLocationExpandedDTO`](internal-8.md#stocklocationexpandeddto) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:37 + +___ + +### AdminStoresRes + +Ƭ **AdminStoresRes**: `Object` + +**`Schema`** + +AdminStoresRes +type: object +required: + - store +properties: + store: + description: Store details. + $ref: "#/components/schemas/Store" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `store` | [`Store`](../classes/internal-8.internal.Store.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/index.d.ts:34 + +___ + +### AdminSwapsListRes + +Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal-3.Swap.md)[] } + +**`Schema`** + +AdminSwapsListRes +type: object +required: + - swaps + - count + - offset + - limit +properties: + swaps: + type: array + description: "An array of swaps details." + items: + $ref: "#/components/schemas/Swap" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of swaps skipped when retrieving the swaps. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/index.d.ts:31 + +___ + +### AdminSwapsRes + +Ƭ **AdminSwapsRes**: `Object` + +**`Schema`** + +AdminSwapsRes +type: object +x-expanded-relations: + field: swap + relations: + - additional_items + - additional_items.adjustments + - cart + - cart.items + - cart.items.adjustments + - cart.items.variant + - fulfillments + - order + - payment + - return_order + - shipping_address + - shipping_methods + eager: + - fulfillments.items + - shipping_methods.shipping_option +required: + - swap +properties: + swap: + description: "Swap details." + $ref: "#/components/schemas/Swap" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal-3.Swap.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/index.d.ts:62 + +___ + +### AdminTaxProvidersList + +Ƭ **AdminTaxProvidersList**: `Object` + +**`Schema`** + +AdminTaxProvidersList +type: object +required: + - tax_providers +properties: + tax_providers: + type: array + description: An array of tax providers details. + items: + $ref: "#/components/schemas/TaxProvider" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_providers` | [`TaxProvider`](../classes/internal-3.TaxProvider.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/index.d.ts:49 + +___ + +### AdminTaxRatesDeleteRes + +Ƭ **AdminTaxRatesDeleteRes**: [`DeleteResponse`](internal-8.internal.md#deleteresponse) + +**`Schema`** + +AdminTaxRatesDeleteRes +type: object +required: + - id + - object + - deleted +properties: + id: + type: string + description: The ID of the deleted Shipping Option. + object: + type: string + description: The type of the object that was deleted. + default: tax-rate + deleted: + type: boolean + description: Whether or not the items were deleted. + default: true + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:27 + +___ + +### AdminTaxRatesListRes + +Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal-3.TaxRate.md)[] } + +**`Schema`** + +AdminTaxRatesListRes +type: object +required: + - tax_rates + - count + - offset + - limit +properties: + tax_rates: + type: array + description: "An array of tax rate details." + items: + $ref: "#/components/schemas/TaxRate" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of tax rates to skip when retrieving the tax rates. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:52 + +___ + +### AdminTaxRatesRes + +Ƭ **AdminTaxRatesRes**: `Object` + +**`Schema`** + +AdminTaxRatesRes +type: object +required: + - tax_rate +properties: + tax_rate: + description: "Tax rate details." + $ref: "#/components/schemas/TaxRate" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `tax_rate` | [`TaxRate`](../classes/internal-3.TaxRate.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:65 + +___ + +### AdminUploadsDownloadUrlRes + +Ƭ **AdminUploadsDownloadUrlRes**: `Object` + +**`Schema`** + +AdminUploadsDownloadUrlRes +type: object +required: + - download_url +properties: + download_url: + description: The Download URL of the file + type: string + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `download_url` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/index.d.ts:62 + +___ + +### AdminUploadsRes + +Ƭ **AdminUploadsRes**: `Object` + +**`Schema`** + +AdminUploadsRes +type: object +required: + - uploads +properties: + uploads: + type: array + description: "Uploaded files details." + items: + type: object + required: + - url + - key + properties: + url: + description: The URL of the uploaded file. + type: string + format: uri + key: + description: The key of the file that is identifiable by the file service. It can be used later to retrieve or manipulate the file. + type: string + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `uploads` | [`FileServiceUploadResult`](internal-8.md#fileserviceuploadresult)[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/uploads/index.d.ts:28 + +___ + +### AdminUserRes + +Ƭ **AdminUserRes**: `Object` + +**`Schema`** + +AdminUserRes +type: object +required: + - user +properties: + user: + description: "User details." + $ref: "#/components/schemas/User" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `user` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> | + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/index.d.ts:16 + +___ + +### AdminUsersListRes + +Ƭ **AdminUsersListRes**: `Object` + +**`Schema`** + +AdminUsersListRes +type: object +required: + - users +properties: + users: + type: array + description: "An array of users details." + items: + $ref: "#/components/schemas/User" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `users` | [`Omit`](internal-1.md#omit)<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/index.d.ts:31 + +___ + +### AdminVariantsListRes + +Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-8.md#pricedvariant)[] } + +**`Schema`** + +AdminVariantsListRes +type: object +x-expanded-relations: + field: variants + relations: + - options + - prices + - product + totals: + - purchasable +required: + - variants + - count + - offset + - limit +properties: + variants: + type: array + description: "An array of product variant details." + items: + $ref: "#/components/schemas/PricedVariant" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product variants skipped when retrieving the product variants. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/index.d.ts:40 + +___ + +### AdminVariantsRes + +Ƭ **AdminVariantsRes**: `Object` + +**`Schema`** + +AdminVariantsRes +type: object +x-expanded-relations: + field: variant + relations: + - options + - prices + - product +required: + - variant +properties: + variant: + description: "Product variant's details." + $ref: "#/components/schemas/PricedVariant" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variant` | [`PricedVariant`](internal-8.md#pricedvariant) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/index.d.ts:59 + +___ + +### BatchJobCreateProps + +Ƭ **BatchJobCreateProps**: [`Pick`](internal-1.md#pick)<[`BatchJob`](../classes/internal-2.BatchJob.md), ``"context"`` \| ``"type"`` \| ``"created_by"`` \| ``"dry_run"``\> + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:36 + +___ + +### BatchJobUpdateProps + +Ƭ **BatchJobUpdateProps**: [`Partial`](internal-8.md#partial)<[`Pick`](internal-1.md#pick)<[`BatchJob`](../classes/internal-2.BatchJob.md), ``"context"`` \| ``"result"``\>\> + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:12 + +___ + +### CartCompletionResponse + +Ƭ **CartCompletionResponse**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `response_body` | [`Record`](internal.md#record)<`string`, `unknown`\> | The response body for the completion request | +| `response_code` | `number` | The response code for the completion request | + +#### Defined in + +packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:4 + +___ + +### ClassConstructor + +Ƭ **ClassConstructor**<`T`\>: (...`args`: `unknown`[]) => `T` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Type declaration + +• **new ClassConstructor**(`...args`): `T` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `unknown`[] | + +##### Returns + +`T` + +#### Defined in + +packages/medusa/dist/types/global.d.ts:28 + +___ + +### ConfigModule + +Ƭ **ConfigModule**: [`ConfigModule`](internal-8.md#configmodule) + +#### Defined in + +packages/medusa/dist/types/global.d.ts:48 + +___ + +### Constructor + +Ƭ **Constructor**<`T`\>: `Object` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa/dist/types/global.d.ts:47 + +___ + +### CreateBatchJobInput + +Ƭ **CreateBatchJobInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `context` | [`BatchJob`](../classes/internal-2.BatchJob.md)[``"context"``] | +| `dry_run` | `boolean` | +| `type` | `string` | + +#### Defined in + +packages/medusa/dist/types/batch-job.d.ts:13 + +___ + +### CreatePriceListInput + +Ƭ **CreatePriceListInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer_groups?` | { `id`: `string` }[] | +| `description` | `string` | +| `ends_at?` | `Date` | +| `includes_tax?` | `boolean` | +| `name` | `string` | +| `prices` | [`AdminPriceListPricesCreateReq`](../classes/internal-8.internal.AdminPriceListPricesCreateReq.md)[] | +| `starts_at?` | `Date` | +| `status?` | [`PriceListStatus`](../enums/internal-3.PriceListStatus.md) | +| `type` | [`PriceListType`](../enums/internal-3.PriceListType.md) | + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:40 + +___ + +### Data + +Ƭ **Data**: [`Record`](internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:3 + +___ + +### DecoratedInventoryItemDTO + +Ƭ **DecoratedInventoryItemDTO**: [`InventoryItemDTO`](internal-8.md#inventoryitemdto) & { `location_levels?`: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] ; `reserved_quantity`: `number` ; `stocked_quantity`: `number` ; `variants?`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] } + +**`Schema`** + +DecoratedInventoryItemDTO +type: object +allOf: + - $ref: "#/components/schemas/InventoryItemDTO" + - type: object + required: + - stocked_quantity + - reserved_quantity + properties: + location_levels: + type: array + description: An array of location level details + items: + $ref: "#/components/schemas/InventoryLevelDTO" + variants: + type: array + description: An array of product variant details + items: + $ref: "#/components/schemas/ProductVariant" + stocked_quantity: + type: number + description: The total quantity of the item in stock across levels + reserved_quantity: + type: number + description: The total quantity of the item available across levels + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:98 + +___ + +### DeleteResponse + +Ƭ **DeleteResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | `string` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:75 + +___ + +### ExtendedFindConfig + +Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](internal-1.md#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](internal-1.md#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:28 + +___ + +### ExtendedRequest + +Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/medusa/dist/types/global.d.ts:25 + +___ + +### ExtendedReservationItem + +Ƭ **ExtendedReservationItem**: [`ReservationItemDTO`](internal-8.md#reservationitemdto) & { `inventory_item?`: [`InventoryItemDTO`](internal-8.md#inventoryitemdto) ; `line_item?`: [`LineItem`](../classes/internal-3.LineItem.md) } + +**`Schema`** + +ExtendedReservationItem +type: object +allOf: + - $ref: "#/components/schemas/ReservationItemDTO" + - type: object + properties: + line_item: + description: The line item associated with the reservation. + $ref: "#/components/schemas/LineItem" + inventory_item: + description: The inventory item associated with the reservation. + $ref: "#/components/schemas/InventoryItemDTO" + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:33 + +___ + +### ItemTaxCalculationLine + +Ƭ **ItemTaxCalculationLine**: `Object` + +A line item and the tax rates that have been configured to apply to the +product contained in the line item. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `item` | [`LineItem`](../classes/internal-3.LineItem.md) | +| `rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:21 + +___ + +### LevelWithAvailability + +Ƭ **LevelWithAvailability**: [`InventoryLevelDTO`](internal-8.md#inventoryleveldto) & { `available_quantity`: `number` } + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:56 + +___ + +### Logger + +Ƭ **Logger**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `activity` | (`message`: `string`, `config?`: `any`) => `void` | +| `debug` | (`message`: `any`) => `void` | +| `error` | (`messageOrError`: `any`, `error?`: `any`) => `void` | +| `failure` | (`activityId`: `any`, `message`: `any`) => `void` | +| `info` | (`message`: `any`) => `void` | +| `log` | (...`args`: `any`[]) => `void` | +| `panic` | (`data`: `any`) => `void` | +| `progress` | (`activityId`: `any`, `message`: `any`) => `void` | +| `setLogLevel` | (`level`: `string`) => `void` | +| `shouldLog` | (`level`: `string`) => `void` | +| `success` | (`activityId`: `any`, `message`: `any`) => `void` | +| `unsetLogLevel` | () => `void` | +| `warn` | (`message`: `any`) => `void` | + +#### Defined in + +packages/medusa/dist/types/global.d.ts:32 + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: [`MedusaContainer`](internal-8.md#medusacontainer-1) + +#### Defined in + +packages/medusa/dist/types/global.d.ts:31 + +___ + +### PartialPick + +Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `T` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:13 + +___ + +### PaymentContext + +Ƭ **PaymentContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `cart` | { `billing_address?`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `context`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `email`: `string` ; `id`: `string` ; `shipping_address`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] } | +| `cart.billing_address?` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | +| `cart.context` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `cart.email` | `string` | +| `cart.id` | `string` | +| `cart.shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | +| `cart.shipping_methods` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | +| `currency_code` | `string` | +| `customer?` | [`Customer`](../classes/internal-3.Customer.md) | +| `paymentSessionData` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `resource_id` | `string` | + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:6 + +___ + +### PaymentData + +Ƭ **PaymentData**: [`Data`](internal-8.internal.md#data) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:4 + +___ + +### PaymentProcessorContext + +Ƭ **PaymentProcessorContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `billing_address?` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | +| `context` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `currency_code` | `string` | +| `customer?` | [`Customer`](../classes/internal-3.Customer.md) | +| `email` | `string` | +| `paymentSessionData` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `resource_id` | `string` | + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:3 + +___ + +### PaymentProcessorSessionResponse + +Ƭ **PaymentProcessorSessionResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `session_data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `update_requests?` | { `customer_metadata?`: [`Record`](internal.md#record)<`string`, `unknown`\> } | +| `update_requests.customer_metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:13 + +___ + +### PaymentSessionData + +Ƭ **PaymentSessionData**: [`Data`](internal-8.internal.md#data) + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:5 + +___ + +### PaymentSessionResponse + +Ƭ **PaymentSessionResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `session_data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `update_requests` | { `customer_metadata`: [`Record`](internal.md#record)<`string`, `unknown`\> } | +| `update_requests.customer_metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:21 + +___ + +### PriceListLoadConfig + +Ƭ **PriceListLoadConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart_id?` | `string` | +| `currency_code?` | `string` | +| `customer_id?` | `string` | +| `include_discount_prices?` | `boolean` | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:76 + +___ + +### PriceListPriceCreateInput + +Ƭ **PriceListPriceCreateInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `currency_code?` | `string` | +| `max_quantity?` | `number` | +| `min_quantity?` | `number` | +| `region_id?` | `string` | +| `variant_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:68 + +___ + +### PriceListPriceUpdateInput + +Ƭ **PriceListPriceUpdateInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount?` | `number` | +| `currency_code?` | `string` | +| `id?` | `string` | +| `max_quantity?` | `number` | +| `min_quantity?` | `number` | +| `region_id?` | `string` | +| `variant_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:59 + +___ + +### PriceSelectionContext + +Ƭ **PriceSelectionContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart_id?` | `string` | +| `currency_code?` | `string` | +| `customer_id?` | `string` | +| `ignore_cache?` | `boolean` | +| `include_discount_prices?` | `boolean` | +| `quantity?` | `number` | +| `region_id?` | `string` | +| `tax_rates?` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:34 + +___ + +### PriceSelectionResult + +Ƭ **PriceSelectionResult**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculatedPrice` | `number` \| ``null`` | +| `calculatedPriceIncludesTax?` | `boolean` \| ``null`` | +| `calculatedPriceType?` | [`PriceType`](internal-8.internal.md#pricetype-1) | +| `originalPrice` | `number` \| ``null`` | +| `originalPriceIncludesTax?` | `boolean` \| ``null`` | +| `prices` | [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[] | + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:53 + +___ + +### PriceType + +Ƭ **PriceType**: [`DefaultPriceType`](../enums/internal-8.DefaultPriceType.md) \| [`PriceListType`](../enums/internal-3.PriceListType.md) + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:47 + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:48 + +___ + +### QueryConfig + +Ƭ **QueryConfig**<`TEntity`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allowedFields?` | `string`[] | +| `allowedRelations?` | `string`[] | +| `defaultFields?` | (keyof `TEntity` \| `string`)[] | +| `defaultLimit?` | `number` | +| `defaultRelations?` | `string`[] | +| `isList?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:55 + +___ + +### QuerySelector + +Ƭ **QuerySelector**<`TEntity`\>: [`Selector`](internal-8.internal.md#selector)<`TEntity`\> & { `q?`: `string` } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:36 + +___ + +### RequestQueryFields + +Ƭ **RequestQueryFields**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `expand?` | `string` | +| `fields?` | `string` | +| `limit?` | `number` | +| `offset?` | `number` | +| `order?` | `string` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:63 + +___ + +### ResponseInventoryItem + +Ƭ **ResponseInventoryItem**: [`Partial`](internal-8.md#partial)<[`InventoryItemDTO`](internal-8.md#inventoryitemdto)\> & { `location_levels?`: [`LevelWithAvailability`](internal-8.internal.md#levelwithavailability)[] } + +**`Schema`** + +ResponseInventoryItem +allOf: + - $ref: "#/components/schemas/InventoryItemDTO" + - type: object + properties: + location_levels: + type: array + description: The inventory's location levels. + items: + allOf: + - $ref: "#/components/schemas/InventoryItemDTO" + - type: object + required: + - available_quantity + properties: + available_quantity: + description: The available quantity in the inventory location. + type: number + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:79 + +___ + +### Selector + +Ƭ **Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:42 + +___ + +### ShippingTaxCalculationLine + +Ƭ **ShippingTaxCalculationLine**: `Object` + +A shipping method and the tax rates that have been configured to apply to the +shipping method. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] | +| `shipping_method` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md) | + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:13 + +___ + +### StoreAuthRes + +Ƭ **StoreAuthRes**: `Object` + +**`Schema`** + +StoreAuthRes +type: object +x-expanded-relations: + field: customer + relations: + - orders + - orders.items + - shipping_addresses +required: + - customer +properties: + customer: + description: "Customer's details." + $ref: "#/components/schemas/Customer" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Customer`](../classes/internal-3.Customer.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/index.d.ts:21 + +___ + +### StoreBearerAuthRes + +Ƭ **StoreBearerAuthRes**: `Object` + +**`Schema`** + +StoreBearerAuthRes +type: object +properties: + accessToken: + description: Access token for subsequent authorization. + type: string + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `access_token` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/index.d.ts:32 + +___ + +### StoreCartShippingOptionsListRes + +Ƭ **StoreCartShippingOptionsListRes**: `Object` + +**`Schema`** + +StoreCartShippingOptionsListRes +type: object +x-expanded-relations: + field: shipping_options + implicit: + - profile + - requirements +required: + - shipping_options +properties: + shipping_options: + type: array + description: "An array of shipping options details." + items: + $ref: "#/components/schemas/PricedShippingOption" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_options` | [`PricedShippingOption`](internal-8.md#pricedshippingoption)[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:41 + +___ + +### StoreCartsRes + +Ƭ **StoreCartsRes**: `Object` + +**`Schema`** + +StoreCartsRes +type: object +x-expanded-relations: + field: cart + relations: + - billing_address + - discounts + - discounts.rule + - gift_cards + - items + - items.adjustments + - items.variant + - payment + - payment_sessions + - region + - region.countries + - region.payment_providers + - shipping_address + - shipping_methods + eager: + - region.fulfillment_providers + - region.payment_providers + - shipping_methods.shipping_option + implicit: + - items + - items.variant + - items.variant.product + - items.variant.product.profiles + - items.tax_lines + - items.adjustments + - gift_cards + - discounts + - discounts.rule + - shipping_methods + - shipping_methods.tax_lines + - shipping_address + - region + - region.tax_rates + totals: + - discount_total + - gift_card_tax_total + - gift_card_total + - item_tax_total + - refundable_amount + - refunded_total + - shipping_tax_total + - shipping_total + - subtotal + - tax_total + - total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total +required: + - cart +properties: + cart: + description: "Cart details." + $ref: "#/components/schemas/Cart" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart` | [`Omit`](internal-1.md#omit)<[`Cart`](../classes/internal-3.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> | + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/index.d.ts:73 + +___ + +### StoreCollectionsListRes + +Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal-3.ProductCollection.md)[] } + +**`Schema`** + +StoreCollectionsListRes +type: object +required: + - collections + - count + - offset + - limit +properties: + collections: + type: array + description: "An array of product collections details" + items: + $ref: "#/components/schemas/ProductCollection" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product collections skipped when retrieving the product collections. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/index.d.ts:31 + +___ + +### StoreCollectionsRes + +Ƭ **StoreCollectionsRes**: `Object` + +**`Schema`** + +StoreCollectionsRes +type: object +required: + - collection +properties: + collection: + description: "Product collection details." + $ref: "#/components/schemas/ProductCollection" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | [`ProductCollection`](../classes/internal-3.ProductCollection.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/index.d.ts:44 + +___ + +### StoreCompleteCartRes + +Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal-3.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal-3.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal-3.Swap.md) ; `type`: ``"swap"`` } + +**`Schema`** + +StoreCompleteCartRes +type: object +required: + - type + - data +properties: + type: + type: string + description: "The type of the data property. If the cart completion fails, type will be `cart` and the data object will be the cart's details. + If the cart completion is successful and the cart is used for checkout, type will be `order` and the data object will be the order's details. + If the cart completion is successful and the cart is used for swap creation, type will be `swap` and the data object will be the swap's details." + enum: [order, cart, swap] + data: + type: object + description: The data of the result object. Its type depends on the type field. + oneOf: + - type: object + allOf: + - description: Cart was successfully authorized and order was placed successfully. + - $ref: "#/components/schemas/Order" + - type: object + allOf: + - description: Cart was successfully authorized but requires further actions. + - $ref: "#/components/schemas/Cart" + - type: object + allOf: + - description: Cart was used for a swap and it has been completed successfully. + - $ref: "#/components/schemas/Swap" + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/index.d.ts:106 + +___ + +### StoreCustomersListOrdersRes + +Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal-3.Order.md)[] } + +**`Schema`** + +StoreCustomersListOrdersRes +type: object +x-expanded-relations: + field: orders + relations: + - customer + - discounts + - discounts.rule + - fulfillments + - fulfillments.tracking_links + - items + - items.variant + - payments + - region + - shipping_address + - shipping_methods + eager: + - region.fulfillment_providers + - region.payment_providers + - shipping_methods.shipping_option + implicit: + - claims + - claims.additional_items + - claims.additional_items.adjustments + - claims.additional_items.refundable + - claims.additional_items.tax_lines + - customer + - discounts + - discounts.rule + - gift_card_transactions + - gift_card_transactions.gift_card + - gift_cards + - items + - items.adjustments + - items.refundable + - items.tax_lines + - items.variant + - items.variant.product + - items.variant.product.profiles + - refunds + - region + - shipping_address + - shipping_methods + - shipping_methods.tax_lines + - swaps + - swaps.additional_items + - swaps.additional_items.adjustments + - swaps.additional_items.refundable + - swaps.additional_items.tax_lines + totals: + - discount_total + - gift_card_tax_total + - gift_card_total + - paid_total + - refundable_amount + - refunded_total + - shipping_total + - subtotal + - tax_total + - total + - claims.additional_items.discount_total + - claims.additional_items.gift_card_total + - claims.additional_items.original_tax_total + - claims.additional_items.original_total + - claims.additional_items.refundable + - claims.additional_items.subtotal + - claims.additional_items.tax_total + - claims.additional_items.total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total + - swaps.additional_items.discount_total + - swaps.additional_items.gift_card_total + - swaps.additional_items.original_tax_total + - swaps.additional_items.original_total + - swaps.additional_items.refundable + - swaps.additional_items.subtotal + - swaps.additional_items.tax_total + - swaps.additional_items.total +required: + - orders + - count + - offset + - limit +properties: + orders: + type: array + description: "An array of orders details." + items: + $ref: "#/components/schemas/Order" + count: + description: The total number of items available + type: integer + offset: + description: The number of orders skipped when retrieving the orders. + type: integer + limit: + description: The number of items per page + type: integer + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:146 + +___ + +### StoreCustomersListPaymentMethodsRes + +Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` + +**`Schema`** + +StoreCustomersListPaymentMethodsRes +type: object +required: + - payment_methods +properties: + payment_methods: + type: array + description: "An array of saved payment method details." + items: + type: object + required: + - provider_id + - data + properties: + provider_id: + description: The ID of the Payment Provider where the payment method is saved. + type: string + data: + description: The data needed for the Payment Provider to use the saved payment method. + type: object + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:171 + +___ + +### StoreCustomersRes + +Ƭ **StoreCustomersRes**: `Object` + +**`Schema`** + +StoreCustomersRes +type: object +x-expanded-relations: + field: customer + relations: + - billing_address + - shipping_addresses +required: + - customer +properties: + customer: + description: "Customer details." + $ref: "#/components/schemas/Customer" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Omit`](internal-1.md#omit)<[`Customer`](../classes/internal-3.Customer.md), ``"password_hash"``\> | + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:24 + +___ + +### StoreCustomersResetPasswordRes + +Ƭ **StoreCustomersResetPasswordRes**: `Object` + +**`Schema`** + +StoreCustomersResetPasswordRes +type: object +required: + - customer +properties: + customer: + description: "Customer details." + $ref: "#/components/schemas/Customer" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer` | [`Omit`](internal-1.md#omit)<[`Customer`](../classes/internal-3.Customer.md), ``"password_hash"``\> | + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:37 + +___ + +### StoreGetAuthEmailRes + +Ƭ **StoreGetAuthEmailRes**: `Object` + +**`Schema`** + +StoreGetAuthEmailRes +type: object +required: + - exists +properties: + exists: + description: Whether email exists or not. + type: boolean + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exists` | `boolean` | + +#### Defined in + +packages/medusa/dist/api/routes/store/auth/index.d.ts:45 + +___ + +### StoreGetProductCategoriesCategoryRes + +Ƭ **StoreGetProductCategoriesCategoryRes**: `Object` + +**`Schema`** + +StoreGetProductCategoriesCategoryRes +type: object +x-expanded-relations: + field: product_category + relations: + - category_children + - parent_category +required: + - product_category +properties: + product_category: + description: "Product category details." + $ref: "#/components/schemas/ProductCategory" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product_category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:27 + +___ + +### StoreGetProductCategoriesRes + +Ƭ **StoreGetProductCategoriesRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)[] } + +**`Schema`** + +StoreGetProductCategoriesRes +type: object +x-expanded-relations: + field: product_categories + relations: + - category_children + - parent_category +required: + - product_categories + - count + - offset + - limit +properties: + product_categories: + type: array + description: "An array of product categories details." + items: + $ref: "#/components/schemas/ProductCategory" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product categories skipped when retrieving the product categories. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:59 + +___ + +### StoreGiftCardsRes + +Ƭ **StoreGiftCardsRes**: `Object` + +**`Schema`** + +StoreGiftCardsRes +type: object +required: + - gift_card +properties: + gift_card: + description: "Gift card details." + $ref: "#/components/schemas/GiftCard" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:18 + +___ + +### StoreOrderEditsRes + +Ƭ **StoreOrderEditsRes**: `Object` + +**`Schema`** + +StoreOrderEditsRes +type: object +x-expanded-relations: + field: order_edit + relations: + - changes + - changes.line_item + - changes.line_item.variant + - changes.original_line_item + - changes.original_line_item.variant + - items + - items.adjustments + - items.tax_lines + - items.variant + - payment_collection + implicit: + - items + - items.tax_lines + - items.adjustments + - items.variant + totals: + - difference_due + - discount_total + - gift_card_tax_total + - gift_card_total + - shipping_total + - subtotal + - tax_total + - total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total +required: + - order_edit +properties: + order_edit: + description: "Order edit details." + $ref: "#/components/schemas/OrderEdit" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order_edit` | [`Omit`](internal-1.md#omit)<[`OrderEdit`](../classes/internal-3.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> | + +#### Defined in + +packages/medusa/dist/api/routes/store/order-edits/index.d.ts:49 + +___ + +### StoreOrdersRes + +Ƭ **StoreOrdersRes**: `Object` + +**`Schema`** + +StoreOrdersRes +type: object +required: + - order +x-expanded-relations: + field: order + relations: + - customer + - discounts + - discounts.rule + - fulfillments + - fulfillments.tracking_links + - items + - items.variant + - payments + - region + - shipping_address + - shipping_methods + eager: + - fulfillments.items + - region.fulfillment_providers + - region.payment_providers + - shipping_methods.shipping_option + implicit: + - claims + - claims.additional_items + - claims.additional_items.adjustments + - claims.additional_items.refundable + - claims.additional_items.tax_lines + - discounts + - discounts.rule + - gift_card_transactions + - gift_card_transactions.gift_card + - gift_cards + - items + - items.adjustments + - items.refundable + - items.tax_lines + - items.variant + - items.variant.product + - items.variant.product.profiles + - refunds + - region + - shipping_methods + - shipping_methods.tax_lines + - swaps + - swaps.additional_items + - swaps.additional_items.adjustments + - swaps.additional_items.refundable + - swaps.additional_items.tax_lines + totals: + - discount_total + - gift_card_tax_total + - gift_card_total + - paid_total + - refundable_amount + - refunded_total + - shipping_total + - subtotal + - tax_total + - total + - claims.additional_items.discount_total + - claims.additional_items.gift_card_total + - claims.additional_items.original_tax_total + - claims.additional_items.original_total + - claims.additional_items.refundable + - claims.additional_items.subtotal + - claims.additional_items.tax_total + - claims.additional_items.total + - items.discount_total + - items.gift_card_total + - items.original_tax_total + - items.original_total + - items.refundable + - items.subtotal + - items.tax_total + - items.total + - swaps.additional_items.discount_total + - swaps.additional_items.gift_card_total + - swaps.additional_items.original_tax_total + - swaps.additional_items.original_total + - swaps.additional_items.refundable + - swaps.additional_items.subtotal + - swaps.additional_items.tax_total + - swaps.additional_items.total +properties: + order: + description: "Order details." + $ref: "#/components/schemas/Order" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal-3.Order.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/index.d.ts:100 + +___ + +### StorePaymentCollectionsRes + +Ƭ **StorePaymentCollectionsRes**: `Object` + +**`Schema`** + +StorePaymentCollectionsRes +type: object +x-expanded-relations: + field: payment_collection + relations: + - payment_sessions + - region + eager: + - region.fulfillment_providers + - region.payment_providers +required: + - payment_collection +properties: + payment_collection: + description: "Payment collection's details." + $ref: "#/components/schemas/PaymentCollection" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_collection` | [`PaymentCollection`](../classes/internal-3.PaymentCollection.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:25 + +___ + +### StorePaymentCollectionsSessionRes + +Ƭ **StorePaymentCollectionsSessionRes**: `Object` + +**`Schema`** + +StorePaymentCollectionsSessionRes +type: object +required: + - payment_session +properties: + payment_session: + description: "Payment session's details." + $ref: "#/components/schemas/PaymentSession" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `payment_session` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:38 + +___ + +### StorePostSearchRes + +Ƭ **StorePostSearchRes**: { `hits`: `unknown`[] } & [`Record`](internal.md#record)<`string`, `unknown`\> + +**`Schema`** + +StorePostSearchRes +allOf: + - type: object + required: + - hits + properties: + hits: + description: "Array of search results. The format of the items depends on the search engine installed on the Medusa backend." + type: array + - type: object + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:86 + +___ + +### StoreProductTagsListRes + +Ƭ **StoreProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal-3.ProductTag.md)[] } + +**`Schema`** + +StoreProductTagsListRes +type: object +required: + - product_tags + - count + - offset + - limit +properties: + product_tags: + type: array + description: "An array of product tags details." + items: + $ref: "#/components/schemas/ProductTag" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product tags skipped when retrieving the product tags. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/index.d.ts:33 + +___ + +### StoreProductTypesListRes + +Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal-3.ProductType.md)[] } + +**`Schema`** + +StoreProductTypesListRes +type: object +required: + - product_types + - count + - offset + - limit +properties: + product_types: + type: array + description: "An array of product types details." + items: + $ref: "#/components/schemas/ProductType" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of product types skipped when retrieving the product types. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/product-types/index.d.ts:33 + +___ + +### StoreProductsListRes + +Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`PricedProduct`](internal-8.md#pricedproduct)[] } + +**`Schema`** + +StoreProductsListRes +type: object +x-expanded-relations: + field: products + relations: + - collection + - images + - options + - options.values + - tags + - type + - variants + - variants.options + - variants.prices + totals: + - variants.purchasable +required: + - products + - count + - offset + - limit +properties: + products: + type: array + description: "An array of products details." + items: + $ref: "#/components/schemas/PricedProduct" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of products skipped when retrieving the products. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:127 + +___ + +### StoreProductsRes + +Ƭ **StoreProductsRes**: `Object` + +**`Schema`** + +StoreProductsRes +type: object +x-expanded-relations: + field: product + relations: + - collection + - images + - options + - options.values + - tags + - type + - variants + - variants.options + - variants.prices + totals: + - variants.purchasable +required: + - product +properties: + product: + description: "Product details." + $ref: "#/components/schemas/PricedProduct" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `product` | [`PricedProduct`](internal-8.md#pricedproduct) | + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:71 + +___ + +### StoreRegionsListRes + +Ƭ **StoreRegionsListRes**: [`PaginatedResponse`](internal-8.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal-3.Region.md)[] } + +**`Schema`** + +StoreRegionsListRes +type: object +x-expanded-relations: + field: regions + relations: + - countries + - payment_providers + - fulfillment_providers + eager: + - payment_providers + - fulfillment_providers +required: + - regions +properties: + regions: + type: array + description: "An array of regions details." + items: + $ref: "#/components/schemas/Region" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of regions skipped when retrieving the regions. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/index.d.ts:36 + +___ + +### StoreRegionsRes + +Ƭ **StoreRegionsRes**: `Object` + +**`Schema`** + +StoreRegionsRes +type: object +x-expanded-relations: + field: region + relations: + - countries + - payment_providers + - fulfillment_providers + eager: + - payment_providers + - fulfillment_providers +required: + - region +properties: + region: + description: "Region details." + $ref: "#/components/schemas/Region" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `region` | [`Region`](../classes/internal-3.Region.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/regions/index.d.ts:58 + +___ + +### StoreReturnReasonsListRes + +Ƭ **StoreReturnReasonsListRes**: `Object` + +**`Schema`** + +StoreReturnReasonsListRes +type: object +x-expanded-relations: + field: return_reasons + relations: + - parent_return_reason + - return_reason_children +required: + - return_reasons +properties: + return_reasons: + type: array + description: "An array of return reasons details." + items: + $ref: "#/components/schemas/ReturnReason" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reasons` | [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:23 + +___ + +### StoreReturnReasonsRes + +Ƭ **StoreReturnReasonsRes**: `Object` + +**`Schema`** + +StoreReturnReasonsRes +type: object +x-expanded-relations: + field: return_reason + relations: + - parent_return_reason + - return_reason_children +required: + - return_reason +properties: + return_reason: + description: "Return reason details." + $ref: "#/components/schemas/ReturnReason" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return_reason` | [`ReturnReason`](../classes/internal-3.ReturnReason.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:41 + +___ + +### StoreReturnsRes + +Ƭ **StoreReturnsRes**: `Object` + +**`Schema`** + +StoreReturnsRes +type: object +x-expanded-relations: + field: return + relations: + - items + - items.reason + eager: + - items +required: + - return +properties: + return: + description: "Return details." + $ref: "#/components/schemas/Return" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `return` | [`Return`](../classes/internal-3.Return.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/returns/index.d.ts:22 + +___ + +### StoreShippingOptionsListRes + +Ƭ **StoreShippingOptionsListRes**: `Object` + +**`Schema`** + +StoreShippingOptionsListRes +type: object +x-expanded-relations: + field: shipping_options + relations: + - requirements +required: + - shipping_options +properties: + shipping_options: + type: array + description: "An array of shipping options details." + items: + $ref: "#/components/schemas/PricedShippingOption" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `shipping_options` | [`PricedShippingOption`](internal-8.md#pricedshippingoption)[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/shipping-options/index.d.ts:21 + +___ + +### StoreSwapsRes + +Ƭ **StoreSwapsRes**: `Object` + +**`Schema`** + +StoreSwapsRes +type: object +x-expanded-relations: + field: swap + relations: + - additional_items + - additional_items.variant + - cart + - fulfillments + - order + - payment + - return_order + - return_order.shipping_method + - shipping_address + - shipping_methods + eager: + - fulfillments.items +required: + - swap +properties: + swap: + description: "Swap details." + $ref: "#/components/schemas/Swap" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `swap` | [`Swap`](../classes/internal-3.Swap.md) | + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/index.d.ts:32 + +___ + +### StoreVariantsListRes + +Ƭ **StoreVariantsListRes**: `Object` + +**`Schema`** + +StoreVariantsListRes +type: object +x-expanded-relations: + field: variants + relations: + - prices + - options + - product + totals: + - purchasable +required: + - variants +properties: + variants: + type: array + description: "An array of product variant descriptions." + items: + $ref: "#/components/schemas/PricedVariant" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variants` | [`PricedVariant`](internal-8.md#pricedvariant)[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/index.d.ts:47 + +___ + +### StoreVariantsRes + +Ƭ **StoreVariantsRes**: `Object` + +**`Schema`** + +StoreVariantsRes +type: object +x-expanded-relations: + field: variant + relations: + - prices + - options + - product + totals: + - purchasable +required: + - variant +properties: + variant: + description: "Product variant description." + $ref: "#/components/schemas/PricedVariant" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variant` | [`PricedVariant`](internal-8.md#pricedvariant) | + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/index.d.ts:24 + +___ + +### TaxCalculationContext + +Ƭ **TaxCalculationContext**: `Object` + +Information relevant to a tax calculation, such as the shipping address where +the items are going. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allocation_map` | [`LineAllocationsMap`](internal-8.md#lineallocationsmap) | +| `customer` | [`Customer`](../classes/internal-3.Customer.md) | +| `is_return` | `boolean` | +| `region` | [`Region`](../classes/internal-3.Region.md) | +| `shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | +| `shipping_methods` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | + +#### Defined in + +packages/medusa/dist/interfaces/tax-service.d.ts:29 + +___ + +### TotalField + +Ƭ **TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"`` + +#### Defined in + +packages/medusa/dist/types/common.d.ts:45 + +___ + +### TreeQuerySelector + +Ƭ **TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](internal-8.internal.md#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:39 + +___ + +### UpdatePriceListInput + +Ƭ **UpdatePriceListInput**: [`Partial`](internal-8.md#partial)<[`Pick`](internal-1.md#pick)<[`PriceList`](../classes/internal-3.PriceList.md), ``"name"`` \| ``"description"`` \| ``"starts_at"`` \| ``"ends_at"`` \| ``"status"`` \| ``"type"`` \| ``"includes_tax"``\>\> & { `customer_groups?`: { `id`: `string` }[] ; `prices?`: [`AdminPriceListPricesUpdateReq`](../classes/internal-8.internal.AdminPriceListPricesUpdateReq.md)[] } + +#### Defined in + +packages/medusa/dist/types/price-list.d.ts:53 + +___ + +### VariantInventory + +Ƭ **VariantInventory**: `Object` + +**`Schema`** + +VariantInventory +type: object +required: + - id + - inventory + - sales_channel_availability +properties: + id: + description: the ID of the variant + type: string + inventory: + description: The inventory details. + $ref: "#/components/schemas/ResponseInventoryItem" + sales_channel_availability: + type: array + description: An array of details about the variant's inventory availability in sales channels. + items: + type: object + required: + - channel_name + - channel_id + - available_quantity + properties: + channel_name: + description: Sales channel's name + type: string + channel_id: + description: Sales channel's ID + type: string + available_quantity: + description: Available quantity in the sales channel + type: number + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `inventory` | [`ResponseInventoryItem`](internal-8.internal.md#responseinventoryitem)[] | +| `sales_channel_availability` | { `available_quantity`: `number` ; `channel_id`: `string` ; `channel_name`: `string` }[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/get-inventory.d.ts:116 + +___ + +### WithRequiredProperty + +Ƭ **WithRequiredProperty**<`T`, `K`\>: `T` & { [Property in K]-?: T[Property] } + +Utility type used to remove some optional attributes (coming from K) from a type T + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `K` | extends keyof `T` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:10 + +___ + +### Writable + +Ƭ **Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator \| FindOperator \| FindOperator } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa/dist/types/common.d.ts:16 + +___ + +### payload + +Ƭ **payload**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `password` | `string` | +| `user_id` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/reset-password.d.ts:68 + +## Variables + +### AvailableOrderIncludes + +• `Const` **AvailableOrderIncludes**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `RETURNABLE_ITEMS` | `string` | + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/index.d.ts:256 + +___ + +### PriceType + +• **PriceType**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `DEFAULT` | [`DEFAULT`](internal-8.md#default) | +| `OVERRIDE` | [`OVERRIDE`](../enums/internal-3.PriceListType.md#override) | +| `SALE` | [`SALE`](../enums/internal-3.PriceListType.md#sale) | + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:47 + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:48 + +___ + +### allowedAdminProductCategoryRelations + +• `Const` **allowedAdminProductCategoryRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:13 + +___ + +### allowedFields + +• `Const` **allowedFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/index.d.ts:6 + +___ + +### allowedOrderIncludes + +• `Const` **allowedOrderIncludes**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/index.d.ts:259 + +___ + +### allowedStoreCustomersFields + +• `Const` **allowedStoreCustomersFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:8 + +___ + +### allowedStoreCustomersRelations + +• `Const` **allowedStoreCustomersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:7 + +___ + +### allowedStoreGiftCardFields + +• `Const` **allowedStoreGiftCardFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:7 + +___ + +### allowedStoreGiftCardRelations + +• `Const` **allowedStoreGiftCardRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:6 + +___ + +### allowedStoreOrdersFields + +• `Const` **allowedStoreOrdersFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/index.d.ts:8 + +___ + +### allowedStoreOrdersRelations + +• `Const` **allowedStoreOrdersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/index.d.ts:6 + +___ + +### allowedStoreProductCategoryFields + +• `Const` **allowedStoreProductCategoryFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:11 + +___ + +### allowedStoreProductTagFields + +• `Const` **allowedStoreProductTagFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/index.d.ts:7 + +___ + +### allowedStoreProductTypeFields + +• `Const` **allowedStoreProductTypeFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-types/index.d.ts:6 + +___ + +### allowedStoreProductsFields + +• `Const` **allowedStoreProductsFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:10 + +___ + +### allowedStoreProductsRelations + +• `Const` **allowedStoreProductsRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:11 + +___ + +### allowedStoreVariantRelations + +• `Const` **allowedStoreVariantRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/index.d.ts:5 + +___ + +### defaulPaymentCollectionRelations + +• `Const` **defaulPaymentCollectionRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:6 + +___ + +### defaultAdminBatchFields + +• `Const` **defaultAdminBatchFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/batch/index.d.ts:45 + +___ + +### defaultAdminCollectionsFields + +• `Const` **defaultAdminCollectionsFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/index.d.ts:6 + +___ + +### defaultAdminCollectionsRelations + +• `Const` **defaultAdminCollectionsRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/collections/index.d.ts:7 + +___ + +### defaultAdminCustomerGroupsRelations + +• `Const` **defaultAdminCustomerGroupsRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customer-groups/index.d.ts:66 + +___ + +### defaultAdminCustomersRelations + +• `Const` **defaultAdminCustomersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/customers/index.d.ts:50 + +___ + +### defaultAdminDiscountConditionFields + +• `Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/internal-3.DiscountCondition.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:9 + +___ + +### defaultAdminDiscountConditionRelations + +• `Const` **defaultAdminDiscountConditionRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:10 + +___ + +### defaultAdminDiscountsFields + +• `Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/internal-3.Discount.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:7 + +___ + +### defaultAdminDiscountsRelations + +• `Const` **defaultAdminDiscountsRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:8 + +___ + +### defaultAdminDraftOrdersCartFields + +• `Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/internal-3.Cart.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:7 + +___ + +### defaultAdminDraftOrdersCartRelations + +• `Const` **defaultAdminDraftOrdersCartRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:6 + +___ + +### defaultAdminDraftOrdersFields + +• `Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/internal-3.DraftOrder.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:8 + +___ + +### defaultAdminDraftOrdersRelations + +• `Const` **defaultAdminDraftOrdersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/index.d.ts:5 + +___ + +### defaultAdminGetProductsVariantsFields + +• `Const` **defaultAdminGetProductsVariantsFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:10 + +___ + +### defaultAdminGiftCardFields + +• `Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/internal-3.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:6 + +___ + +### defaultAdminGiftCardRelations + +• `Const` **defaultAdminGiftCardRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/gift-cards/index.d.ts:7 + +___ + +### defaultAdminInventoryItemFields + +• `Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](internal-8.md#inventoryitemdto)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:7 + +___ + +### defaultAdminInventoryItemRelations + +• `Const` **defaultAdminInventoryItemRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:9 + +___ + +### defaultAdminLocationLevelFields + +• `Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/index.d.ts:8 + +___ + +### defaultAdminNotificationsFields + +• `Const` **defaultAdminNotificationsFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/index.d.ts:6 + +___ + +### defaultAdminNotificationsRelations + +• `Const` **defaultAdminNotificationsRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/notifications/index.d.ts:5 + +___ + +### defaultAdminPriceListFields + +• `Const` **defaultAdminPriceListFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:7 + +___ + +### defaultAdminPriceListRelations + +• `Const` **defaultAdminPriceListRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/index.d.ts:8 + +___ + +### defaultAdminProductCategoryRelations + +• `Const` **defaultAdminProductCategoryRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:12 + +___ + +### defaultAdminProductFields + +• `Const` **defaultAdminProductFields**: keyof [`Product`](../classes/internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:9 + +___ + +### defaultAdminProductRelations + +• `Const` **defaultAdminProductRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:8 + +___ + +### defaultAdminProductRemoteQueryObject + +• `Const` **defaultAdminProductRemoteQueryObject**: `Object` + +This is temporary. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | { `fields`: `string`[] } | +| `collection.fields` | `string`[] | +| `fields` | keyof [`Product`](../classes/internal-3.Product.md)[] | +| `images` | { `fields`: `string`[] } | +| `images.fields` | `string`[] | +| `options` | { `fields`: `string`[] ; `values`: { `fields`: `string`[] } } | +| `options.fields` | `string`[] | +| `options.values` | { `fields`: `string`[] } | +| `options.values.fields` | `string`[] | +| `profile` | { `fields`: `string`[] } | +| `profile.fields` | `string`[] | +| `tags` | { `fields`: `string`[] } | +| `tags.fields` | `string`[] | +| `type` | { `fields`: `string`[] } | +| `type.fields` | `string`[] | +| `variants` | { `fields`: `string`[] ; `options`: { `fields`: `string`[] } } | +| `variants.fields` | `string`[] | +| `variants.options` | { `fields`: `string`[] } | +| `variants.options.fields` | `string`[] | + +#### Defined in + +packages/medusa/dist/api/routes/admin/products/index.d.ts:14 + +___ + +### defaultAdminProductTagsFields + +• `Const` **defaultAdminProductTagsFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:6 + +___ + +### defaultAdminProductTagsRelations + +• `Const` **defaultAdminProductTagsRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-tags/index.d.ts:7 + +___ + +### defaultAdminProductTypeFields + +• `Const` **defaultAdminProductTypeFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/index.d.ts:6 + +___ + +### defaultAdminProductTypeRelations + +• `Const` **defaultAdminProductTypeRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-types/index.d.ts:7 + +___ + +### defaultAdminRegionFields + +• `Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/internal-3.Region.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:7 + +___ + +### defaultAdminRegionRelations + +• `Const` **defaultAdminRegionRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/regions/index.d.ts:8 + +___ + +### defaultAdminReservationRelations + +• `Const` **defaultAdminReservationRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:64 + +___ + +### defaultAdminReturnReasonsFields + +• `Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:5 + +___ + +### defaultAdminReturnReasonsRelations + +• `Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/return-reasons/index.d.ts:6 + +___ + +### defaultAdminShippingProfilesFields + +• `Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:6 + +___ + +### defaultAdminShippingProfilesRelations + +• `Const` **defaultAdminShippingProfilesRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:7 + +___ + +### defaultAdminStockLocationFields + +• `Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](internal-8.md#stocklocationdto)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:4 + +___ + +### defaultAdminStockLocationRelations + +• `Const` **defaultAdminStockLocationRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/index.d.ts:5 + +___ + +### defaultAdminSwapFields + +• `Const` **defaultAdminSwapFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/index.d.ts:6 + +___ + +### defaultAdminSwapRelations + +• `Const` **defaultAdminSwapRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/swaps/index.d.ts:5 + +___ + +### defaultAdminTaxRatesFields + +• `Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/internal-3.TaxRate.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:6 + +___ + +### defaultAdminTaxRatesRelations + +• `Const` **defaultAdminTaxRatesRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/tax-rates/index.d.ts:5 + +___ + +### defaultAdminVariantFields + +• `Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/index.d.ts:7 + +___ + +### defaultAdminVariantRelations + +• `Const` **defaultAdminVariantRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/variants/index.d.ts:6 + +___ + +### defaultFields + +• `Const` **defaultFields**: keyof [`ShippingOption`](../classes/internal-3.ShippingOption.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/shipping-options/index.d.ts:6 + +___ + +### defaultPaymentCollectionFields + +• `Const` **defaultPaymentCollectionFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/payment-collections/index.d.ts:5 + +___ + +### defaultPaymentCollectionRelations + +• `Const` **defaultPaymentCollectionRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/payment-collections/index.d.ts:6 + +___ + +### defaultPaymentFields + +• `Const` **defaultPaymentFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/payments/index.d.ts:5 + +___ + +### defaultProductCategoryFields + +• `Const` **defaultProductCategoryFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/index.d.ts:14 + +___ + +### defaultRelations + +• `Const` **defaultRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:6 + +___ + +### defaultRelationsExtended + +• `Const` **defaultRelationsExtended**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/store/index.d.ts:5 + +___ + +### defaultRelationsList + +• `Const` **defaultRelationsList**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:7 + +___ + +### defaultReservationFields + +• `Const` **defaultReservationFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/index.d.ts:65 + +___ + +### defaultReturnCancelFields + +• `Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/internal-3.Order.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:9 + +___ + +### defaultReturnCancelRelations + +• `Const` **defaultReturnCancelRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/returns/index.d.ts:8 + +___ + +### defaultStoreCartFields + +• `Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/internal-3.Cart.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/index.d.ts:5 + +___ + +### defaultStoreCartRelations + +• `Const` **defaultStoreCartRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/carts/index.d.ts:6 + +___ + +### defaultStoreCategoryScope + +• `Const` **defaultStoreCategoryScope**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `is_active` | `boolean` | +| `is_internal` | `boolean` | + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:6 + +___ + +### defaultStoreCollectionRelations + +• `Const` **defaultStoreCollectionRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/collections/index.d.ts:5 + +___ + +### defaultStoreCustomersFields + +• `Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/internal-3.Customer.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:6 + +___ + +### defaultStoreCustomersRelations + +• `Const` **defaultStoreCustomersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/customers/index.d.ts:5 + +___ + +### defaultStoreGiftCardFields + +• `Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/internal-3.GiftCard.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:5 + +___ + +### defaultStoreGiftCardRelations + +• `Const` **defaultStoreGiftCardRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/gift-cards/index.d.ts:4 + +___ + +### defaultStoreOrdersFields + +• `Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/internal-3.Order.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/index.d.ts:7 + +___ + +### defaultStoreOrdersRelations + +• `Const` **defaultStoreOrdersRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/orders/index.d.ts:5 + +___ + +### defaultStoreProductCategoryFields + +• `Const` **defaultStoreProductCategoryFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:10 + +___ + +### defaultStoreProductCategoryRelations + +• `Const` **defaultStoreProductCategoryRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/index.d.ts:5 + +___ + +### defaultStoreProductRemoteQueryObject + +• `Const` **defaultStoreProductRemoteQueryObject**: `Object` + +This is temporary. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `collection` | { `fields`: `string`[] } | +| `collection.fields` | `string`[] | +| `fields` | keyof [`Product`](../classes/internal-3.Product.md)[] | +| `images` | { `fields`: `string`[] } | +| `images.fields` | `string`[] | +| `options` | { `fields`: `string`[] ; `values`: { `fields`: `string`[] } } | +| `options.fields` | `string`[] | +| `options.values` | { `fields`: `string`[] } | +| `options.values.fields` | `string`[] | +| `profile` | { `fields`: `string`[] } | +| `profile.fields` | `string`[] | +| `tags` | { `fields`: `string`[] } | +| `tags.fields` | `string`[] | +| `type` | { `fields`: `string`[] } | +| `type.fields` | `string`[] | +| `variants` | { `fields`: `string`[] ; `options`: { `fields`: `string`[] } } | +| `variants.fields` | `string`[] | +| `variants.options` | { `fields`: `string`[] } | +| `variants.options.fields` | `string`[] | + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:15 + +___ + +### defaultStoreProductTagFields + +• `Const` **defaultStoreProductTagFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/index.d.ts:6 + +___ + +### defaultStoreProductTagRelations + +• `Const` **defaultStoreProductTagRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-tags/index.d.ts:8 + +___ + +### defaultStoreProductTypeFields + +• `Const` **defaultStoreProductTypeFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-types/index.d.ts:7 + +___ + +### defaultStoreProductTypeRelations + +• `Const` **defaultStoreProductTypeRelations**: `never`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/product-types/index.d.ts:8 + +___ + +### defaultStoreProductsFields + +• `Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/internal-3.Product.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:9 + +___ + +### defaultStoreProductsRelations + +• `Const` **defaultStoreProductsRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/products/index.d.ts:8 + +___ + +### defaultStoreReturnReasonFields + +• `Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:4 + +___ + +### defaultStoreReturnReasonRelations + +• `Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/internal-3.ReturnReason.md)[] + +#### Defined in + +packages/medusa/dist/api/routes/store/return-reasons/index.d.ts:5 + +___ + +### defaultStoreSwapFields + +• `Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Swap`](../classes/internal-3.Swap.md)\>[``"select"``] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/index.d.ts:6 + +___ + +### defaultStoreSwapRelations + +• `Const` **defaultStoreSwapRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/swaps/index.d.ts:5 + +___ + +### defaultStoreVariantRelations + +• `Const` **defaultStoreVariantRelations**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/store/variants/index.d.ts:4 + +___ + +### filterableAdminOrdersFields + +• `Const` **filterableAdminOrdersFields**: `string`[] + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/index.d.ts:255 + +## Functions + +### DbAwareColumn + +▸ **DbAwareColumn**(`columnOptions`): [`PropertyDecorator`](internal-8.md#propertydecorator) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `columnOptions` | `ColumnOptions` | + +#### Returns + +[`PropertyDecorator`](internal-8.md#propertydecorator) + +#### Defined in + +packages/medusa/dist/utils/db-aware-column.d.ts:4 + +___ + +### IsType + +▸ **IsType**(`types`, `validationOptions?`): (`object`: [`Object`](internal-8.md#object), `propertyName`: `string`) => `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `types` | `any`[] | +| `validationOptions?` | `ValidationOptions` | + +#### Returns + +`fn` + +▸ (`object`, `propertyName`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | [`Object`](internal-8.md#object) | +| `propertyName` | `string` | + +##### Returns + +`void` + +#### Defined in + +packages/medusa/dist/utils/validators/is-type.d.ts:2 + +___ + +### addOrderToSelect + +▸ **addOrderToSelect**<`TEntity`\>(`order`, `select`): `void` + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | `FindOptionsOrder`<`TEntity`\> | +| `select` | `FindOptionsSelect`<`TEntity`\> | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/utils/build-query.d.ts:29 + +___ + +### adjustInventoryForCancelledFulfillment + +▸ **adjustInventoryForCancelledFulfillment**(`fulfillment`, `context`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillment` | [`Fulfillment`](../classes/internal-3.Fulfillment.md) | +| `context` | `Object` | +| `context.productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/cancel-fulfillment.d.ts:62 + +___ + +### authenticate + +▸ **authenticate**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Defined in + +packages/medusa/dist/api/middlewares/authenticate.d.ts:2 + +___ + +### authenticateCustomer + +▸ **authenticateCustomer**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Defined in + +packages/medusa/dist/api/middlewares/authenticate-customer.d.ts:2 + +___ + +### buildLegacyFieldsListFrom + +▸ **buildLegacyFieldsListFrom**<`TEntity`\>(`input?`): keyof `TEntity`[] + +Revert new object structure of find options to the legacy structure of previous version + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input?` | `FindOptionsWhere`<`TEntity`\> \| `FindOptionsSelect`<`TEntity`\> \| `FindOptionsOrder`<`TEntity`\> \| `FindOptionsRelations`<`TEntity`\> | + +#### Returns + +keyof `TEntity`[] + +**`Deprecated`** + +in favor of import { objectToStringPath } from "@medusajs/utils" + +**`Example`** + +```ts +input: { + test: { + test1: true, + test2: true, + test3: { + test4: true + }, + }, + test2: true +} +output: ['test.test1', 'test.test2', 'test.test3.test4', 'test2'] +``` + +#### Defined in + +packages/medusa/dist/utils/build-query.d.ts:28 + +___ + +### buildQuery + +▸ **buildQuery**<`TWhereKeys`, `TEntity`\>(`selector`, `config?`): [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<`TEntity`\> + +Used to build TypeORM queries. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `TWhereKeys` | extends `object` | +| `TEntity` | `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `selector` | `TWhereKeys` | The selector | +| `config?` | [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<`TEntity`\> | The config | + +#### Returns + +[`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<`TEntity`\> + +The QueryBuilderConfig + +#### Defined in + +packages/medusa/dist/utils/build-query.d.ts:10 + +___ + +### calculatePriceTaxAmount + +▸ **calculatePriceTaxAmount**(`«destructured»`): `number` + +Return the tax amount that +- is includes in the price if it is tax inclusive +- will be applied on to the price if it is tax exclusive + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `includesTax?` | `boolean` | +| › `price` | `number` | +| › `taxRate` | `number` | + +#### Returns + +`number` + +#### Defined in + +packages/medusa/dist/utils/calculate-price-tax-amount.d.ts:9 + +___ + +### canAccessBatchJob + +▸ **canAccessBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `any` | +| `res` | `any` | +| `next` | `any` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/batch-job/can-access-batch-job.d.ts:1 + +___ + +### categoryMatchesScope + +▸ **categoryMatchesScope**(`category`, `query`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `category` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | +| `query` | `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/utils/product-category/index.d.ts:3 + +___ + +### cleanResponseData + +▸ **cleanResponseData**<`T`\>(`data`, `fields`): `T` extends [] ? [`Partial`](internal-8.md#partial)<`T`\>[] : [`Partial`](internal-8.md#partial)<`T`\> + +Filter response data to contain props specified in the `allowedProperties`. +You can read more in the transformQuery middleware utility methods. + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `unknown` | + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `data` | `T` | record or an array of records in the response | +| `fields` | `string`[] | record props allowed in the response | + +#### Returns + +`T` extends [] ? [`Partial`](internal-8.md#partial)<`T`\>[] : [`Partial`](internal-8.md#partial)<`T`\> + +#### Defined in + +packages/medusa/dist/utils/clean-response-data.d.ts:8 + +___ + +### csvCellContentFormatter + +▸ **csvCellContentFormatter**(`str`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:1 + +___ + +### csvRevertCellContentFormatter + +▸ **csvRevertCellContentFormatter**(`str`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `str` | `string` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/utils/csv-cell-content-formatter.d.ts:2 + +___ + +### doesConditionBelongToDiscount + +▸ **doesConditionBelongToDiscount**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `any` | +| `res` | `any` | +| `next` | `any` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/discount/does-condition-belong-to-discount.d.ts:1 + +___ + +### errorHandler + +▸ **errorHandler**(): (`err`: [`MedusaError`](../classes/internal-8.MedusaError.md), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\>, `res`: `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\>, `next`: `NextFunction`) => `void` + +#### Returns + +`fn` + +▸ (`err`, `req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | [`MedusaError`](../classes/internal-8.MedusaError.md) | +| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> | +| `res` | `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\> | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +packages/medusa/dist/api/middlewares/error-handler.d.ts:3 + +___ + +### extendedFindParamsMixin + +▸ **extendedFindParamsMixin**(`«destructured»?`): [`ClassConstructor`](internal-8.internal.md#classconstructor)<[`FindParams`](../classes/internal-6.FindParams.md) & [`FindPaginationParams`](../classes/internal-4.FindPaginationParams.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `«destructured»` | `Object` | +| › `limit?` | `number` | +| › `offset?` | `number` | + +#### Returns + +[`ClassConstructor`](internal-8.internal.md#classconstructor)<[`FindParams`](../classes/internal-6.FindParams.md) & [`FindPaginationParams`](../classes/internal-4.FindPaginationParams.md)\> + +#### Defined in + +packages/medusa/dist/types/common.d.ts:246 + +___ + +### fetchCategoryDescendantsIds + +▸ **fetchCategoryDescendantsIds**(`productCategory`, `query`): `string`[] + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `productCategory` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) | +| `query` | `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> | + +#### Returns + +`string`[] + +#### Defined in + +packages/medusa/dist/utils/product-category/index.d.ts:4 + +___ + +### formatException + +▸ **formatException**(`err`): [`MedusaError`](../classes/internal-8.MedusaError.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `any` | + +#### Returns + +[`MedusaError`](../classes/internal-8.MedusaError.md) + +#### Defined in + +packages/medusa/dist/utils/exception-formatter.d.ts:8 + +___ + +### generateEntityId + +▸ **generateEntityId**(`idProperty`, `prefix?`): `string` + +Generate a composed id based on the input parameters and return either the is if it exists or the generated one. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `idProperty` | `string` | +| `prefix?` | `string` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/utils/generate-entity-id.d.ts:6 + +___ + +### getRequestedBatchJob + +▸ **getRequestedBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `any` | +| `res` | `any` | +| `next` | `any` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/batch-job/get-requested-batch-job.d.ts:1 + +___ + +### hasChanges + +▸ **hasChanges**<`T1`, `T2`\>(`obj1`, `obj2`): `boolean` + +Compare two objects and return true if there is changes detected from obj2 compared to obj1 + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T1` | extends [`Object`](internal-8.md#object) | +| `T2` | extends [`Object`](internal-8.md#object) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj1` | `T1` | +| `obj2` | `T2` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/utils/has-changes.d.ts:6 + +___ + +### isBatchJobStrategy + +▸ **isBatchJobStrategy**(`object`): object is IBatchJobStrategy + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `unknown` | + +#### Returns + +object is IBatchJobStrategy + +#### Defined in + +packages/medusa/dist/interfaces/batch-job-strategy.d.ts:34 + +___ + +### isCartCompletionStrategy + +▸ **isCartCompletionStrategy**(`obj`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `unknown` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/cart-completion-strategy.d.ts:24 + +___ + +### isDate + +▸ **isDate**(`value`): value is Date + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +value is Date + +#### Defined in + +packages/medusa/dist/utils/is-date.d.ts:1 + +___ + +### isFileService + +▸ **isFileService**(`object`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `unknown` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/file-service.d.ts:48 + +___ + +### isNotificationService + +▸ **isNotificationService**(`obj`): `boolean` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `unknown` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:17 + +___ + +### isObject + +▸ **isObject**(`obj`): obj is object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `any` | + +#### Returns + +obj is object + +#### Defined in + +packages/medusa/dist/utils/is-object.d.ts:1 + +___ + +### isPaymentProcessor + +▸ **isPaymentProcessor**(`obj`): `boolean` + +Return if the input object is AbstractPaymentProcessor + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `unknown` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:110 + +___ + +### isPaymentProcessorError + +▸ **isPaymentProcessorError**(`obj`): obj is PaymentProcessorError + +Utility function to determine if an object is a processor error + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `any` | + +#### Returns + +obj is PaymentProcessorError + +#### Defined in + +packages/medusa/dist/interfaces/payment-processor.d.ts:115 + +___ + +### isPaymentService + +▸ **isPaymentService**(`obj`): `boolean` + +Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `obj` | `unknown` | + +#### Returns + +`boolean` + +#### Defined in + +packages/medusa/dist/interfaces/payment-service.d.ts:185 + +___ + +### isPriceSelectionStrategy + +▸ **isPriceSelectionStrategy**(`object`): object is IPriceSelectionStrategy + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `any` | + +#### Returns + +object is IPriceSelectionStrategy + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:33 + +___ + +### isString + +▸ **isString**(`val`): val is string + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `val` | `any` | + +#### Returns + +val is string + +#### Defined in + +packages/medusa/dist/utils/is-string.d.ts:1 + +___ + +### isTaxCalculationStrategy + +▸ **isTaxCalculationStrategy**(`object`): object is ITaxCalculationStrategy + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `object` | `any` | + +#### Returns + +object is ITaxCalculationStrategy + +#### Defined in + +packages/medusa/dist/interfaces/tax-calculation-strategy.d.ts:16 + +___ + +### normalizeQuery + +▸ **normalizeQuery**(): (`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\>, `res`: `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\>, `next`: `NextFunction`) => `void` + +Normalize an input query, especially from array like query params to an array type +e.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: ["id", "status", "cart_id"] } + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> | +| `res` | `Response`<`any`, [`Record`](internal.md#record)<`string`, `any`\>\> | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +packages/medusa/dist/api/middlewares/normalized-query.d.ts:6 + +___ + +### nullableValue + +▸ **nullableValue**(`value`): `FindOperator`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +`FindOperator`<`any`\> + +#### Defined in + +packages/medusa/dist/utils/build-query.d.ts:30 + +___ + +### omitDeep + +▸ **omitDeep**<`T`\>(`input`, `excludes`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `object` = `object` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | `object` | +| `excludes` | (`string` \| `number`)[] | + +#### Returns + +`T` + +#### Defined in + +packages/medusa/dist/utils/omit-deep.d.ts:1 + +___ + +### registerOverriddenValidators + +▸ **registerOverriddenValidators**(`extendedValidator`): `void` + +When overriding a validator, you can register it to be used instead of the original one. +For example, the place where you are overriding the core validator, you can call this function + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `extendedValidator` | [`Constructor`](internal-8.md#constructor)<`any`\> | + +#### Returns + +`void` + +**`Example`** + +```ts +// /src/api/routes/admin/products/create-product.ts +import { registerOverriddenValidators } from "@medusajs/medusa" +import { AdminPostProductsReq as MedusaAdminPostProductsReq } from "@medusajs/medusa/dist/api/routes/admin/products/create-product" +import { IsString } from "class-validator" + +class AdminPostProductsReq extends MedusaAdminPostProductsReq { + @IsString() + test: string +} + +registerOverriddenValidators(AdminPostProductsReq) +``` + +#### Defined in + +packages/medusa/dist/utils/validator.d.ts:23 + +___ + +### remoteQueryFetchData + +▸ **remoteQueryFetchData**(`container`): (`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `container` | [`MedusaContainer`](internal-8.md#medusacontainer) | + +#### Returns + +`fn` + +▸ (`expand`, `keyField`, `ids`, `relationship`): `Promise`<`any`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `expand` | `any` | +| `keyField` | `any` | +| `ids` | `any` | +| `relationship` | `any` | + +##### Returns + +`Promise`<`any`\> + +#### Defined in + +packages/medusa/dist/utils/remote-query-fetch-data.d.ts:2 + +___ + +### removeUndefinedProperties + +▸ **removeUndefinedProperties**<`T`\>(`inputObj`): `T` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends `object` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `inputObj` | `T` | + +#### Returns + +`T` + +#### Defined in + +packages/medusa/dist/utils/remove-undefined-properties.d.ts:1 + +___ + +### requireCustomerAuthentication + +▸ **requireCustomerAuthentication**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Defined in + +packages/medusa/dist/api/middlewares/require-customer-authentication.d.ts:2 + +___ + +### reserveQuantityForDraftOrder + +▸ **reserveQuantityForDraftOrder**(`order`, `context`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `order` | [`Order`](../classes/internal-3.Order.md) | +| `context` | `Object` | +| `context.locationId?` | `string` | +| `context.productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/draft-orders/register-payment.d.ts:58 + +___ + +### resolveDbGenerationStrategy + +▸ **resolveDbGenerationStrategy**(`pgSqlType`): ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pgSqlType` | ``"uuid"`` \| ``"rowid"`` \| ``"increment"`` | + +#### Returns + +``"increment"`` \| ``"uuid"`` \| ``"rowid"`` + +#### Defined in + +packages/medusa/dist/utils/db-aware-column.d.ts:3 + +___ + +### resolveDbType + +▸ **resolveDbType**(`pgSqlType`): `ColumnType` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `pgSqlType` | `ColumnType` | + +#### Returns + +`ColumnType` + +#### Defined in + +packages/medusa/dist/utils/db-aware-column.d.ts:2 + +___ + +### setMetadata + +▸ **setMetadata**(`obj`, `metadata`): [`Record`](internal.md#record)<`string`, `unknown`\> + +Dedicated method to set metadata. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `obj` | `undefined` \| ``null`` \| { `metadata`: ``null`` \| [`Record`](internal.md#record)<`string`, `unknown`\> } | the entity to apply metadata to. | +| `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> | the metadata to set | + +#### Returns + +[`Record`](internal.md#record)<`string`, `unknown`\> + +resolves to the updated result. + +#### Defined in + +packages/medusa/dist/utils/set-metadata.d.ts:7 + +___ + +### transformBody + +▸ **transformBody**<`T`\>(`plainToClass`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | +| `config?` | `ValidatorOptions` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `res` | `Response` | +| `next` | `NextFunction` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/transform-body.d.ts:4 + +___ + +### transformIncludesOptions + +▸ **transformIncludesOptions**(`allowedIncludes?`, `expectedIncludes?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `void` + +Retrieve the includes options from the fields query param. +If the include option is present then assigned it to includes on req + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `allowedIncludes?` | `string`[] | The list of fields that can be passed and assign to req.includes | +| `expectedIncludes?` | `string`[] | The list of fields that the consumer can pass to the end point using this middleware. It is a subset of `allowedIncludes` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `res` | `Response` | +| `next` | `NextFunction` | + +##### Returns + +`void` + +#### Defined in + +packages/medusa/dist/api/middlewares/transform-includes-options.d.ts:8 + +___ + +### transformQuery + +▸ **transformQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> + +Middleware that transform the query input for the admin end points + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`RequestQueryFields`](internal-8.internal.md#requestqueryfields) | +| `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | +| `queryConfig?` | [`Omit`](internal-1.md#omit)<[`QueryConfig`](internal-8.internal.md#queryconfig)<`TEntity`\>, ``"allowedRelations"`` \| ``"allowedFields"``\> | +| `config?` | `ValidatorOptions` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `res` | `Response` | +| `next` | `NextFunction` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/transform-query.d.ts:12 + +___ + +### transformStoreQuery + +▸ **transformStoreQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> + +Middleware that transform the query input for the store endpoints + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | extends [`RequestQueryFields`](internal-8.internal.md#requestqueryfields) | +| `TEntity` | extends [`BaseEntity`](../classes/internal-1.BaseEntity.md) | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `plainToClass` | [`ClassConstructor`](internal-8.internal.md#classconstructor)<`T`\> | +| `queryConfig?` | [`QueryConfig`](internal-8.internal.md#queryconfig)<`TEntity`\> | +| `config?` | `ValidatorOptions` | + +#### Returns + +`fn` + +▸ (`req`, `res`, `next`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `res` | `Response` | +| `next` | `NextFunction` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/transform-query.d.ts:19 + +___ + +### unauthenticatedInviteRoutes + +▸ **unauthenticatedInviteRoutes**(`app`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `app` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/api/routes/admin/invites/index.d.ts:4 + +___ + +### unauthenticatedUserRoutes + +▸ **unauthenticatedUserRoutes**(`app`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `app` | `any` | + +#### Returns + +`void` + +#### Defined in + +packages/medusa/dist/api/routes/admin/users/index.d.ts:3 + +___ + +### updateInventoryAndReservations + +▸ **updateInventoryAndReservations**(`fulfillments`, `context`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fulfillments` | [`Fulfillment`](../classes/internal-3.Fulfillment.md)[] | +| `context` | `Object` | +| `context.inventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `context.locationId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/routes/admin/orders/create-fulfillment.d.ts:85 + +___ + +### validateId + +▸ **validateId**(`rawId`, `config?`): `string` + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `rawId` | `string` | +| `config?` | `Object` | +| `config.length?` | `number` | +| `config.prefix?` | `string` | + +#### Returns + +`string` + +#### Defined in + +packages/medusa/dist/utils/validate-id.d.ts:1 + +___ + +### validator + +▸ **validator**<`T`, `V`\>(`typedClass`, `plain`, `config?`): `Promise`<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | +| `V` | + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `typedClass` | `ClassConstructor`<`T`\> | +| `plain` | `V` | +| `config?` | `ValidatorOptions` | + +#### Returns + +`Promise`<`T`\> + +#### Defined in + +packages/medusa/dist/utils/validator.d.ts:24 + +___ + +### wrapHandler + +▸ **wrapHandler**(`fn`): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `fn` | [`handler`](internal-8.md#handler) | + +#### Returns + +`RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, [`Record`](internal.md#record)<`string`, `any`\>\> + +#### Defined in + +packages/medusa/dist/api/middlewares/await-middleware.d.ts:3 diff --git a/www/apps/docs/content/references/js-client/modules/internal-8.md b/www/apps/docs/content/references/js-client/modules/internal-8.md index 0510586ece..5bb12c9e3a 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-8.md +++ b/www/apps/docs/content/references/js-client/modules/internal-8.md @@ -1,55 +1,7138 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- + +# Module: internal + +## Namespaces + +- [EventEmitter](internal-8.EventEmitter.md) +- [internal](internal-8.internal.md) +- [internal](internal-8.internal-1.md) +- [internal](internal-8.internal-2.md) +- [internal](internal-8.internal-3.md) +- [internal](internal-8.internal-4.md) + +## Enumerations + +- [DefaultPriceType](../enums/internal-8.DefaultPriceType.md) +- [DiscountConditionJoinTableForeignKey](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) +- [FulfillmentStatus](../enums/internal-8.FulfillmentStatus.md) +- [MODULE\_RESOURCE\_TYPE](../enums/internal-8.MODULE_RESOURCE_TYPE.md) +- [OrderStatus](../enums/internal-8.OrderStatus.md) +- [PaymentStatus](../enums/internal-8.PaymentStatus.md) ## Classes -- [AdminGetDraftOrdersParams](../classes/internal-8.AdminGetDraftOrdersParams.md) -- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) -- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md) -- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md) -- [AdminPostDraftOrdersReq](../classes/internal-8.AdminPostDraftOrdersReq.md) +- [AbstractEventBusModuleService](../classes/internal-8.AbstractEventBusModuleService.md) +- [AbstractSearchService](../classes/internal-8.AbstractSearchService.md) +- [AdditionalItem](../classes/internal-8.AdditionalItem.md) +- [AdditionalItem](../classes/internal-8.AdditionalItem-1.md) +- [AdditionalItem](../classes/internal-8.AdditionalItem-2.md) +- [AdminCreateCondition](../classes/internal-8.AdminCreateCondition.md) +- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md) +- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminGetDiscountsDiscountConditionsConditionParams.md) +- [AdminGetDiscountsDiscountRuleParams](../classes/internal-8.AdminGetDiscountsDiscountRuleParams.md) +- [AdminGetDiscountsParams](../classes/internal-8.AdminGetDiscountsParams.md) +- [AdminListOrdersSelector](../classes/internal-8.AdminListOrdersSelector.md) +- [AdminPostDiscountsDiscountConditions](../classes/internal-8.AdminPostDiscountsDiscountConditions.md) +- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-8.AdminPostDiscountsDiscountConditionsCondition.md) +- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchParams.md) +- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionBatchReq.md) +- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsConditionParams.md) +- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-8.AdminPostDiscountsDiscountConditionsParams.md) +- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-8.AdminPostDiscountsDiscountDynamicCodesReq.md) +- [AdminPostDiscountsDiscountReq](../classes/internal-8.AdminPostDiscountsDiscountReq.md) +- [AdminPostDiscountsDiscountRule](../classes/internal-8.AdminPostDiscountsDiscountRule.md) +- [AdminPostDiscountsReq](../classes/internal-8.AdminPostDiscountsReq.md) +- [AdminPriceSelectionParams](../classes/internal-8.AdminPriceSelectionParams.md) +- [AdminProductCategoriesReqBase](../classes/internal-8.AdminProductCategoriesReqBase.md) +- [AdminUpdateDiscountRule](../classes/internal-8.AdminUpdateDiscountRule.md) +- [AdminUpsertCondition](../classes/internal-8.AdminUpsertCondition.md) +- [AdminUpsertConditionsReq](../classes/internal-8.AdminUpsertConditionsReq.md) +- [Blob](../classes/internal-8.Blob.md) +- [CustomShippingOption](../classes/internal-8.CustomShippingOption.md) +- [CustomerGroup](../classes/internal-8.CustomerGroup.md) +- [CustomerGroup](../classes/internal-8.CustomerGroup-1.md) +- [CustomerGroupUpdate](../classes/internal-8.CustomerGroupUpdate.md) - [Discount](../classes/internal-8.Discount.md) - [Discount](../classes/internal-8.Discount-1.md) +- [Discount](../classes/internal-8.Discount-2.md) +- [Discount](../classes/internal-8.Discount-3.md) +- [Duplex](../classes/internal-8.Duplex.md) +- [EventEmitter](../classes/internal-8.EventEmitter-1.md) +- [FilterableCartProps](../classes/internal-8.FilterableCartProps.md) +- [FilterableDiscountProps](../classes/internal-8.FilterableDiscountProps.md) +- [FilterableLineItemAdjustmentProps](../classes/internal-8.FilterableLineItemAdjustmentProps.md) +- [FilterableProductProps](../classes/internal-8.FilterableProductProps.md) +- [FilterableProductVariantProps](../classes/internal-8.FilterableProductVariantProps.md) +- [FlagRouter](../classes/internal-8.FlagRouter.md) +- [FulfillmentService](../classes/internal-8.FulfillmentService.md) +- [GiftCard](../classes/internal-8.GiftCard.md) +- [GiftCard](../classes/internal-8.GiftCard-1.md) +- [Image](../classes/internal-8.Image.md) - [Item](../classes/internal-8.Item.md) +- [Item](../classes/internal-8.Item-1.md) +- [Item](../classes/internal-8.Item-2.md) +- [Item](../classes/internal-8.Item-3.md) +- [Item](../classes/internal-8.Item-4.md) +- [Item](../classes/internal-8.Item-5.md) +- [Item](../classes/internal-8.Item-6.md) +- [MedusaError](../classes/internal-8.MedusaError.md) +- [NotificationProvider](../classes/internal-8.NotificationProvider.md) +- [OptionRequirement](../classes/internal-8.OptionRequirement.md) +- [OptionRequirement](../classes/internal-8.OptionRequirement-1.md) +- [OrdersReturnItem](../classes/internal-8.OrdersReturnItem.md) +- [PassThrough](../classes/internal-8.PassThrough.md) +- [PaymentMethod](../classes/internal-8.PaymentMethod.md) +- [PaymentService](../classes/internal-8.PaymentService.md) +- [PriceSelectionParams](../classes/internal-8.PriceSelectionParams.md) +- [ProductBatchProductCategory](../classes/internal-8.ProductBatchProductCategory.md) +- [ProductBatchSalesChannel](../classes/internal-8.ProductBatchSalesChannel.md) +- [ProductOptionReq](../classes/internal-8.ProductOptionReq.md) +- [ProductProductCategoryReq](../classes/internal-8.ProductProductCategoryReq.md) +- [ProductSalesChannelReq](../classes/internal-8.ProductSalesChannelReq.md) +- [ProductTagReq](../classes/internal-8.ProductTagReq.md) +- [ProductTypeReq](../classes/internal-8.ProductTypeReq.md) +- [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq.md) +- [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-1.md) +- [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-2.md) +- [ProductVariantOptionReq](../classes/internal-8.ProductVariantOptionReq-3.md) +- [ProductVariantPricesCreateReq](../classes/internal-8.ProductVariantPricesCreateReq.md) +- [ProductVariantPricesUpdateReq](../classes/internal-8.ProductVariantPricesUpdateReq.md) +- [ProductVariantReq](../classes/internal-8.ProductVariantReq.md) +- [ProductVariantReq](../classes/internal-8.ProductVariantReq-1.md) +- [Readable](../classes/internal-8.Readable.md) +- [ReadableBase](../classes/internal-8.ReadableBase.md) +- [ReturnItem](../classes/internal-8.ReturnItem.md) +- [ReturnShipping](../classes/internal-8.ReturnShipping.md) +- [ReturnShipping](../classes/internal-8.ReturnShipping-1.md) +- [ReturnShipping](../classes/internal-8.ReturnShipping-2.md) +- [ReturnShipping](../classes/internal-8.ReturnShipping-3.md) - [ShippingMethod](../classes/internal-8.ShippingMethod.md) +- [ShippingMethod](../classes/internal-8.ShippingMethod-1.md) +- [ShippingMethod](../classes/internal-8.ShippingMethod-2.md) +- [ShippingMethod](../classes/internal-8.ShippingMethod-3.md) +- [StockLocationAddress](../classes/internal-8.StockLocationAddress.md) +- [StockLocationAddress](../classes/internal-8.StockLocationAddress-1.md) +- [Stream](../classes/internal-8.Stream.md) +- [Tag](../classes/internal-8.Tag.md) +- [Transform](../classes/internal-8.Transform.md) +- [WritableBase](../classes/internal-8.WritableBase.md) +- [internal](../classes/internal-8.internal-5.md) + +## Interfaces + +- [ArrayBufferView](../interfaces/internal-8.ArrayBufferView.md) +- [ArrayLike](../interfaces/internal-8.ArrayLike.md) +- [AsyncGenerator](../interfaces/internal-8.AsyncGenerator.md) +- [AsyncGeneratorFunction](../interfaces/internal-8.AsyncGeneratorFunction.md) +- [AsyncIterable](../interfaces/internal-8.AsyncIterable.md) +- [AsyncIterableIterator](../interfaces/internal-8.AsyncIterableIterator.md) +- [AsyncIterator](../interfaces/internal-8.AsyncIterator.md) +- [BlobOptions](../interfaces/internal-8.BlobOptions.md) +- [Buffer](../interfaces/internal-8.Buffer.md) +- [BufferConstructor](../interfaces/internal-8.BufferConstructor.md) +- [CallSite](../interfaces/internal-8.CallSite.md) +- [CreateNoteInput](../interfaces/internal-8.CreateNoteInput.md) +- [CreateUserInput](../interfaces/internal-8.CreateUserInput.md) +- [DuplexOptions](../interfaces/internal-8.DuplexOptions.md) +- [ErrnoException](../interfaces/internal-8.ErrnoException.md) +- [Error](../interfaces/internal-8.Error.md) +- [EventEmitter](../interfaces/internal-8.EventEmitter-2.md) +- [EventEmitterOptions](../interfaces/internal-8.EventEmitterOptions.md) +- [FindConfig](../interfaces/internal-8.FindConfig.md) +- [ICacheService](../interfaces/internal-8.ICacheService.md) +- [IEventBusModuleService](../interfaces/internal-8.IEventBusModuleService.md) +- [IEventBusService](../interfaces/internal-8.IEventBusService.md) +- [IFlagRouter](../interfaces/internal-8.IFlagRouter.md) +- [IInventoryService](../interfaces/internal-8.IInventoryService.md) +- [ISearchService](../interfaces/internal-8.ISearchService.md) +- [IStockLocationService](../interfaces/internal-8.IStockLocationService.md) +- [ITransactionBaseService](../interfaces/internal-8.ITransactionBaseService.md) +- [Iterable](../interfaces/internal-8.Iterable.md) +- [IterableIterator](../interfaces/internal-8.IterableIterator.md) +- [Iterator](../interfaces/internal-8.Iterator.md) +- [IteratorReturnResult](../interfaces/internal-8.IteratorReturnResult.md) +- [IteratorYieldResult](../interfaces/internal-8.IteratorYieldResult.md) +- [JoinerServiceConfig](../interfaces/internal-8.JoinerServiceConfig.md) +- [JoinerServiceConfigAlias](../interfaces/internal-8.JoinerServiceConfigAlias.md) +- [Logger](../interfaces/internal-8.Logger.md) +- [NumericalComparisonOperator](../interfaces/internal-8.NumericalComparisonOperator.md) +- [Object](../interfaces/internal-8.Object.md) +- [PromiseLike](../interfaces/internal-8.PromiseLike.md) +- [QueuingStrategy](../interfaces/internal-8.QueuingStrategy.md) +- [QueuingStrategySize](../interfaces/internal-8.QueuingStrategySize.md) +- [ReadWriteStream](../interfaces/internal-8.ReadWriteStream.md) +- [ReadableByteStreamController](../interfaces/internal-8.ReadableByteStreamController.md) +- [ReadableByteStreamControllerCallback](../interfaces/internal-8.ReadableByteStreamControllerCallback.md) +- [ReadableStream](../interfaces/internal-8.ReadableStream.md) +- [ReadableStream](../interfaces/internal-8.ReadableStream-1.md) +- [ReadableStreamDefaultController](../interfaces/internal-8.ReadableStreamDefaultController.md) +- [ReadableStreamDefaultReadDoneResult](../interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md) +- [ReadableStreamDefaultReadValueResult](../interfaces/internal-8.ReadableStreamDefaultReadValueResult.md) +- [ReadableStreamDefaultReader](../interfaces/internal-8.ReadableStreamDefaultReader.md) +- [ReadableStreamErrorCallback](../interfaces/internal-8.ReadableStreamErrorCallback.md) +- [ReadableStreamGenericReader](../interfaces/internal-8.ReadableStreamGenericReader.md) +- [ReadableWritablePair](../interfaces/internal-8.ReadableWritablePair.md) +- [SharedArrayBuffer](../interfaces/internal-8.SharedArrayBuffer.md) +- [SharedArrayBufferConstructor](../interfaces/internal-8.SharedArrayBufferConstructor.md) +- [StaticEventEmitterOptions](../interfaces/internal-8.StaticEventEmitterOptions.md) +- [StreamPipeOptions](../interfaces/internal-8.StreamPipeOptions.md) +- [StringComparisonOperator](../interfaces/internal-8.StringComparisonOperator.md) +- [TransformOptions](../interfaces/internal-8.TransformOptions.md) +- [UnderlyingByteSource](../interfaces/internal-8.UnderlyingByteSource.md) +- [UnderlyingSink](../interfaces/internal-8.UnderlyingSink.md) +- [UnderlyingSinkAbortCallback](../interfaces/internal-8.UnderlyingSinkAbortCallback.md) +- [UnderlyingSinkCloseCallback](../interfaces/internal-8.UnderlyingSinkCloseCallback.md) +- [UnderlyingSinkStartCallback](../interfaces/internal-8.UnderlyingSinkStartCallback.md) +- [UnderlyingSinkWriteCallback](../interfaces/internal-8.UnderlyingSinkWriteCallback.md) +- [UnderlyingSource](../interfaces/internal-8.UnderlyingSource.md) +- [UnderlyingSourceCancelCallback](../interfaces/internal-8.UnderlyingSourceCancelCallback.md) +- [UnderlyingSourcePullCallback](../interfaces/internal-8.UnderlyingSourcePullCallback.md) +- [UnderlyingSourceStartCallback](../interfaces/internal-8.UnderlyingSourceStartCallback.md) +- [UpdateUserInput](../interfaces/internal-8.UpdateUserInput.md) +- [WritableStream](../interfaces/internal-8.WritableStream.md) +- [WritableStream](../interfaces/internal-8.WritableStream-1.md) +- [WritableStreamDefaultController](../interfaces/internal-8.WritableStreamDefaultController.md) +- [WritableStreamDefaultWriter](../interfaces/internal-8.WritableStreamDefaultWriter.md) +- [\_DOMEventTarget](../interfaces/internal-8._DOMEventTarget.md) +- [\_NodeEventTarget](../interfaces/internal-8._NodeEventTarget.md) + +## References + +### Abortable + +Re-exports [Abortable](../interfaces/internal-8.EventEmitter.Abortable.md) + +___ + +### ReadableOptions + +Re-exports [ReadableOptions](../interfaces/internal-8.internal-2.ReadableOptions.md) + +___ + +### WritableOptions + +Re-exports [WritableOptions](../interfaces/internal-8.internal-2.WritableOptions.md) + +## Enumeration Members + +### DEFAULT + +• **DEFAULT**: ``"default"`` + +#### Defined in + +packages/medusa/dist/interfaces/price-selection-strategy.d.ts:45 + +___ + +### EXTERNAL + +• **EXTERNAL**: ``"external"`` + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:11 + +___ + +### INTERNAL + +• **INTERNAL**: ``"internal"`` + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:10 ## Type Aliases -### AdminDraftOrdersListRes +### AddOrderEditLineItemInput -Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] } - -#### Defined in - -medusa/dist/api/routes/admin/draft-orders/index.d.ts:18 - -___ - -### AdminDraftOrdersRes - -Ƭ **AdminDraftOrdersRes**: `Object` +Ƭ **AddOrderEditLineItemInput**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `quantity` | `number` | +| `variant_id` | `string` | #### Defined in -medusa/dist/api/routes/admin/draft-orders/index.d.ts:14 +packages/medusa/dist/types/order-edit.d.ts:6 ___ -### AdminPostDraftOrdersDraftOrderRegisterPaymentRes +### AdjustmentContext -Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` +Ƭ **AdjustmentContext**: `Object` #### Type declaration | Name | Type | | :------ | :------ | -| `order` | [`Order`](../classes/internal.Order.md) | +| `variant` | { `product_id`: `string` } | +| `variant.product_id` | `string` | #### Defined in -medusa/dist/api/routes/admin/draft-orders/index.d.ts:11 +packages/medusa/dist/services/line-item-adjustment.d.ts:14 + +___ + +### AdminDiscountConditionsRes + +Ƭ **AdminDiscountConditionsRes**: `Object` + +**`Schema`** + +AdminDiscountConditionsRes +type: object +x-expanded-relations: + field: discount_condition + relations: + - discount_rule +required: + - discount_condition +properties: + discount_condition: + description: "Discount condition details." + $ref: "#/components/schemas/DiscountCondition" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount_condition` | [`DiscountCondition`](../classes/internal-3.DiscountCondition.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:48 + +___ + +### AdminDiscountsListRes + +Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal-3.Discount.md)[] } + +**`Schema`** + +AdminDiscountsListRes +type: object +x-expanded-relations: + field: discounts + relations: + - parent_discount + - regions + - rule + - rule.conditions +required: + - discounts + - count + - offset + - limit +properties: + discounts: + type: array + items: + $ref: "#/components/schemas/Discount" + count: + type: integer + description: The total number of items available + offset: + type: integer + description: The number of discounts skipped when retrieving the discounts. + limit: + type: integer + description: The number of items per page + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:129 + +___ + +### AdminDiscountsRes + +Ƭ **AdminDiscountsRes**: `Object` + +**`Schema`** + +AdminDiscountsRes +type: object +x-expanded-relations: + field: discount + relations: + - parent_discount + - regions + - rule + - rule.conditions + eager: + - regions.fulfillment_providers + - regions.payment_providers +required: + - discount +properties: + discount: + description: "Discount details." + $ref: "#/components/schemas/Discount" + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount` | [`Discount`](../classes/internal-3.Discount.md) | + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/index.d.ts:31 + +___ + +### AllocationMapOptions + +Ƭ **AllocationMapOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exclude_discounts?` | `boolean` | +| `exclude_gift_cards?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:54 + +___ + +### ArrayBufferLike + +Ƭ **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1701 + +___ + +### ArrayBufferView + +Ƭ **ArrayBufferView**: [`TypedArray`](internal-8.md#typedarray) \| `DataView` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:251 + +___ + +### AuthenticateResult + +Ƭ **AuthenticateResult**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer?` | [`Customer`](../classes/internal-3.Customer.md) | +| `error?` | `string` | +| `success` | `boolean` | +| `user?` | [`User`](../classes/internal-1.User.md) | + +#### Defined in + +packages/medusa/dist/types/auth.d.ts:2 + +___ + +### AvailabilityContext + +Ƭ **AvailabilityContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `inventoryLocationMap?` | `Map`<`string`, [`InventoryLevelDTO`](internal-8.md#inventoryleveldto)[]\> | +| `variantInventoryMap?` | `Map`<`string`, [`ProductVariantInventoryItem`](../classes/internal-3.ProductVariantInventoryItem.md)[]\> | + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:19 + +___ + +### BinaryLike + +Ƭ **BinaryLike**: `string` \| [`ArrayBufferView`](internal-8.md#arraybufferview) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/crypto.d.ts:656 + +___ + +### BufferEncoding + +Ƭ **BufferEncoding**: ``"ascii"`` \| ``"utf8"`` \| ``"utf-8"`` \| ``"utf16le"`` \| ``"ucs2"`` \| ``"ucs-2"`` \| ``"base64"`` \| ``"base64url"`` \| ``"latin1"`` \| ``"binary"`` \| ``"hex"`` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:223 + +___ + +### CalculateOptionPriceInput + +Ƭ **CalculateOptionPriceInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `provider_id` | `string` | + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:16 + +___ + +### CalculationContextData + +Ƭ **CalculationContextData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claims?` | [`ClaimOrder`](../classes/internal-3.ClaimOrder.md)[] | +| `customer` | [`Customer`](../classes/internal-3.Customer.md) | +| `discounts` | [`Discount`](../classes/internal-3.Discount.md)[] | +| `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | +| `region` | [`Region`](../classes/internal-3.Region.md) | +| `shipping_address` | [`Address`](../classes/internal-3.Address.md) \| ``null`` | +| `shipping_methods?` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] | +| `swaps?` | [`Swap`](../classes/internal-3.Swap.md)[] | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:2 + +___ + +### CalculationContextOptions + +Ƭ **CalculationContextOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exclude_discounts?` | `boolean` | +| `exclude_gift_cards?` | `boolean` | +| `exclude_shipping?` | `boolean` | +| `is_return?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:58 + +___ + +### CartCreateProps + +Ƭ **CartCreateProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `billing_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | +| `billing_address_id?` | `string` | +| `context?` | `object` | +| `country_code?` | `string` | +| `customer_id?` | `string` | +| `discounts?` | [`Discount`](../classes/internal-8.Discount-3.md)[] | +| `email?` | `string` | +| `gift_cards?` | [`GiftCard`](../classes/internal-8.GiftCard-1.md)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `region?` | [`Region`](../classes/internal-3.Region.md) | +| `region_id?` | `string` | +| `sales_channel_id?` | `string` | +| `shipping_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | +| `shipping_address_id?` | `string` | +| `type?` | [`CartType`](../enums/internal-3.CartType.md) | + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:31 + +___ + +### CartUpdateProps + +Ƭ **CartUpdateProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | +| `billing_address_id?` | `string` | +| `completed_at?` | `Date` | +| `context?` | `object` | +| `country_code?` | `string` | +| `customer_id?` | `string` | +| `discounts?` | [`Discount`](../classes/internal-8.Discount-3.md)[] | +| `email?` | `string` | +| `gift_cards?` | [`GiftCard`](../classes/internal-8.GiftCard-1.md)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `payment_authorized_at?` | `Date` \| ``null`` | +| `region_id?` | `string` | +| `sales_channel_id?` | `string` | +| `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | +| `shipping_address_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:48 + +___ + +### CategoryQueryParams + +Ƭ **CategoryQueryParams**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `value` | `string`[] | + +#### Defined in + +packages/medusa/dist/repositories/product.d.ts:5 + +___ + +### ClaimTypeValue + +Ƭ **ClaimTypeValue**: \`${ClaimType}\` + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:3 + +___ + +### ConfigModule + +Ƭ **ConfigModule**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlags` | [`Record`](internal.md#record)<`string`, `boolean` \| `string`\> | +| `modules?` | [`Record`](internal.md#record)<`string`, ``false`` \| `string` \| [`Partial`](internal-8.md#partial)<[`InternalModuleDeclaration`](internal-8.md#internalmoduledeclaration) \| [`ExternalModuleDeclaration`](internal-8.md#externalmoduledeclaration)\>\> | +| `plugins` | ({ `options`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] | +| `projectConfig` | [`ProjectConfigOptions`](internal-8.md#projectconfigoptions) | + +#### Defined in + +packages/types/dist/common/config-module.d.ts:39 + +___ + +### Constructor + +Ƭ **Constructor**<`T`\>: `Object` + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:5 + +___ + +### CreateAnalyticsConfig + +Ƭ **CreateAnalyticsConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `anonymize` | `boolean` | +| `opt_out` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/analytics-config.d.ts:1 + +___ + +### CreateClaimInput + +Ƭ **CreateClaimInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `additional_items?` | [`CreateClaimItemAdditionalItemInput`](internal-8.md#createclaimitemadditionaliteminput)[] | +| `claim_items` | [`CreateClaimItemInput`](internal-8.md#createclaimiteminput)[] | +| `claim_order_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | +| `order` | [`Order`](../classes/internal-3.Order.md) | +| `refund_amount?` | `number` | +| `return_location_id?` | `string` | +| `return_shipping?` | [`CreateClaimReturnShippingInput`](internal-8.md#createclaimreturnshippinginput) | +| `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | +| `shipping_address_id?` | `string` | +| `shipping_methods?` | [`CreateClaimShippingMethodInput`](internal-8.md#createclaimshippingmethodinput)[] | +| `type` | [`ClaimTypeValue`](internal-8.md#claimtypevalue) | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:4 + +___ + +### CreateClaimItemAdditionalItemInput + +Ƭ **CreateClaimItemAdditionalItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `quantity` | `number` | +| `variant_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:38 + +___ + +### CreateClaimItemInput + +Ƭ **CreateClaimItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claim_order_id?` | `string` | +| `images?` | `string`[] | +| `item_id` | `string` | +| `note?` | `string` | +| `quantity` | `number` | +| `reason` | [`ClaimReason`](../enums/internal-3.ClaimReason.md) | +| `tags?` | `string`[] | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:29 + +___ + +### CreateClaimReturnShippingInput + +Ƭ **CreateClaimReturnShippingInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `option_id?` | `string` | +| `price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:19 + +___ + +### CreateClaimShippingMethodInput + +Ƭ **CreateClaimShippingMethodInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `id?` | `string` | +| `option_id?` | `string` | +| `price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:23 + +___ + +### CreateCustomShippingOptionInput + +Ƭ **CreateCustomShippingOptionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `price` | `number` | +| `shipping_option_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:46 + +___ + +### CreateCustomerInput + +Ƭ **CreateCustomerInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `email` | `string` | +| `first_name?` | `string` | +| `has_account?` | `boolean` | +| `last_name?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `password?` | `string` | +| `password_hash?` | `string` | +| `phone?` | `string` | + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:7 + +___ + +### CreateDiscountInput + +Ƭ **CreateDiscountInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `ends_at?` | `Date` | +| `is_disabled` | `boolean` | +| `is_dynamic` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `regions?` | `string`[] \| [`Region`](../classes/internal-3.Region.md)[] | +| `rule` | [`CreateDiscountRuleInput`](internal-8.md#creatediscountruleinput) | +| `starts_at?` | `Date` | +| `usage_limit?` | `number` | +| `valid_duration?` | `string` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:57 + +___ + +### CreateDiscountRuleInput + +Ƭ **CreateDiscountRuleInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allocation` | [`AllocationType`](../enums/internal-3.AllocationType.md) | +| `conditions?` | [`DiscountConditionInput`](internal-8.md#discountconditioninput)[] | +| `description?` | `string` | +| `type` | [`DiscountRuleType`](../enums/internal-3.DiscountRuleType.md) | +| `value` | `number` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:50 + +___ + +### CreateDynamicDiscountInput + +Ƭ **CreateDynamicDiscountInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `ends_at?` | `Date` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `usage_limit` | `number` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:87 + +___ + +### CreateFulfillmentOrder + +Ƭ **CreateFulfillmentOrder**: [`Omit`](internal-1.md#omit)<[`ClaimOrder`](../classes/internal-3.ClaimOrder.md), ``"beforeInsert"``\> & { `billing_address`: [`Address`](../classes/internal-3.Address.md) ; `currency_code`: `string` ; `discounts`: [`Discount`](../classes/internal-3.Discount.md)[] ; `display_id`: `number` ; `email?`: `string` ; `is_claim?`: `boolean` ; `is_swap?`: `boolean` ; `items`: [`LineItem`](../classes/internal-3.LineItem.md)[] ; `no_notification`: `boolean` ; `payments`: [`Payment`](../classes/internal-3.Payment.md)[] ; `region?`: [`Region`](../classes/internal-3.Region.md) ; `region_id`: `string` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] ; `tax_rate`: `number` \| ``null`` } + +#### Defined in + +packages/medusa/dist/types/fulfillment.d.ts:15 + +___ + +### CreateGiftCardInput + +Ƭ **CreateGiftCardInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `balance?` | `number` | +| `ends_at?` | `Date` | +| `is_disabled?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `order_id?` | `string` | +| `region_id` | `string` | +| `tax_rate?` | `number` \| ``null`` | +| `value?` | `number` | + +#### Defined in + +packages/medusa/dist/types/gift-card.d.ts:1 + +___ + +### CreateGiftCardTransactionInput + +Ƭ **CreateGiftCardTransactionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `created_at?` | `Date` | +| `gift_card_id` | `string` | +| `is_taxable?` | `boolean` | +| `order_id` | `string` | +| `tax_rate?` | `number` \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/gift-card.d.ts:18 + +___ + +### CreateIdempotencyKeyInput + +Ƭ **CreateIdempotencyKeyInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `idempotency_key?` | `string` | +| `request_method?` | `string` | +| `request_params?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `request_path?` | `string` | + +#### Defined in + +packages/medusa/dist/types/idempotency-key.d.ts:1 + +___ + +### CreateInventoryItemInput + +Ƭ **CreateInventoryItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `length?` | `number` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `mid_code?` | `string` | +| `origin_country?` | `string` | +| `requires_shipping?` | `boolean` | +| `sku?` | `string` | +| `thumbnail?` | `string` | +| `title?` | `string` | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:213 + +___ + +### CreateInventoryLevelInput + +Ƭ **CreateInventoryLevelInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `incoming_quantity?` | `number` | +| `inventory_item_id` | `string` | +| `location_id` | `string` | +| `reserved_quantity?` | `number` | +| `stocked_quantity` | `number` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:246 + +___ + +### CreateOauthInput + +Ƭ **CreateOauthInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `application_name` | `string` | +| `display_name` | `string` | +| `install_url?` | `string` | +| `uninstall_url?` | `string` | + +#### Defined in + +packages/medusa/dist/types/oauth.d.ts:1 + +___ + +### CreateOrderEditInput + +Ƭ **CreateOrderEditInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `internal_note?` | `string` | +| `order_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/order-edit.d.ts:2 + +___ + +### CreateOrderEditItemChangeInput + +Ƭ **CreateOrderEditItemChangeInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `line_item_id?` | `string` | +| `order_edit_id` | `string` | +| `original_line_item_id?` | `string` | +| `type` | [`OrderEditItemChangeType`](../enums/internal-3.OrderEditItemChangeType.md) | + +#### Defined in + +packages/medusa/dist/types/order-edit.d.ts:11 + +___ + +### CreatePaymentCollectionInput + +Ƭ **CreatePaymentCollectionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `created_by` | `string` | +| `currency_code` | `string` | +| `description?` | `string` | +| `metadata?` | `any` | +| `region_id` | `string` | +| `type` | [`PaymentCollectionType`](../enums/internal-8.internal.PaymentCollectionType.md) | + +#### Defined in + +packages/medusa/dist/types/payment-collection.d.ts:2 + +___ + +### CreatePaymentInput + +Ƭ **CreatePaymentInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `cart_id?` | `string` | +| `currency_code` | `string` | +| `payment_session` | [`PaymentSession`](../classes/internal-3.PaymentSession.md) | +| `provider_id?` | `string` | +| `resource_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/payment.d.ts:19 + +___ + +### CreateProductCategoryInput + +Ƭ **CreateProductCategoryInput**: [`ProductCategoryInput`](internal-8.md#productcategoryinput) & { `name`: `string` } + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:11 + +___ + +### CreateProductCollection + +Ƭ **CreateProductCollection**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `handle?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `title` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-collection.d.ts:1 + +___ + +### CreateProductInput + +Ƭ **CreateProductInput**: `Object` + +Service Level DTOs + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `categories?` | [`CreateProductProductCategoryInput`](internal-8.md#createproductproductcategoryinput)[] \| ``null`` | +| `collection_id?` | `string` | +| `description?` | `string` | +| `discountable?` | `boolean` | +| `external_id?` | `string` \| ``null`` | +| `handle?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `images?` | `string`[] | +| `is_giftcard?` | `boolean` | +| `length?` | `number` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `mid_code?` | `string` | +| `options?` | [`CreateProductProductOption`](internal-8.md#createproductproductoption)[] | +| `origin_country?` | `string` | +| `profile_id?` | `string` | +| `sales_channels?` | [`CreateProductProductSalesChannelInput`](internal-8.md#createproductproductsaleschannelinput)[] \| ``null`` | +| `status?` | [`ProductStatus`](../enums/internal-3.ProductStatus.md) | +| `subtitle?` | `string` | +| `tags?` | [`CreateProductProductTagInput`](internal-8.md#createproductproducttaginput)[] | +| `thumbnail?` | `string` | +| `title` | `string` | +| `type?` | [`CreateProductProductTypeInput`](internal-8.md#createproductproducttypeinput) | +| `variants?` | [`CreateProductProductVariantInput`](internal-8.md#createproductproductvariantinput)[] | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:38 + +___ + +### CreateProductProductCategoryInput + +Ƭ **CreateProductProductCategoryInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:74 + +___ + +### CreateProductProductOption + +Ƭ **CreateProductProductOption**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `title` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:129 + +___ + +### CreateProductProductSalesChannelInput + +Ƭ **CreateProductProductSalesChannelInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:71 + +___ + +### CreateProductProductTagInput + +Ƭ **CreateProductProductTagInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id?` | `string` | +| `value` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:67 + +___ + +### CreateProductProductTypeInput + +Ƭ **CreateProductProductTypeInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id?` | `string` | +| `value` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:77 + +___ + +### CreateProductProductVariantInput + +Ƭ **CreateProductProductVariantInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allow_backorder?` | `boolean` | +| `barcode?` | `string` | +| `ean?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `inventory_quantity?` | `number` | +| `length?` | `number` | +| `manage_inventory?` | `boolean` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `mid_code?` | `string` | +| `options?` | { `value`: `string` }[] | +| `origin_country?` | `string` | +| `prices?` | [`CreateProductProductVariantPriceInput`](internal-8.md#createproductproductvariantpriceinput)[] | +| `sku?` | `string` | +| `title` | `string` | +| `upc?` | `string` | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:81 + +___ + +### CreateProductProductVariantPriceInput + +Ƭ **CreateProductProductVariantPriceInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `currency_code?` | `string` | +| `max_quantity?` | `number` | +| `min_quantity?` | `number` | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:132 + +___ + +### CreateProductVariantInput + +Ƭ **CreateProductVariantInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allow_backorder?` | `boolean` | +| `barcode?` | `string` | +| `ean?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `inventory_quantity?` | `number` | +| `length?` | `number` | +| `manage_inventory?` | `boolean` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `mid_code?` | `string` | +| `options` | [`ProductVariantOption`](internal-8.md#productvariantoption)[] | +| `origin_country?` | `string` | +| `prices` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | +| `product_id?` | `string` | +| `sku?` | `string` | +| `title?` | `string` | +| `upc?` | `string` | +| `variant_rank?` | `number` | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:21 + +___ + +### CreateRegionInput + +Ƭ **CreateRegionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `countries` | `string`[] | +| `currency_code` | `string` | +| `fulfillment_providers` | `string`[] | +| `includes_tax?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | +| `payment_providers` | `string`[] | +| `tax_code?` | `string` | +| `tax_rate` | `number` | + +#### Defined in + +packages/medusa/dist/types/region.d.ts:15 + +___ + +### CreateReservationItemInput + +Ƭ **CreateReservationItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `created_by?` | `string` | +| `description?` | `string` | +| `external_id?` | `string` | +| `inventory_item_id` | `string` | +| `line_item_id?` | `string` | +| `location_id` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `quantity` | `number` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:229 + +___ + +### CreateReturnInput + +Ƭ **CreateReturnInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claim_order_id?` | `string` | +| `items?` | [`OrdersReturnItem`](internal-8.md#ordersreturnitem)[] | +| `location_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | +| `order_id` | `string` | +| `refund_amount?` | `number` | +| `shipping_method?` | { `option_id?`: `string` ; `price?`: `number` } | +| `shipping_method.option_id?` | `string` | +| `shipping_method.price?` | `number` | +| `swap_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/return.d.ts:7 + +___ + +### CreateReturnReason + +Ƭ **CreateReturnReason**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description?` | `string` | +| `label` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `parent_return_reason_id?` | `string` | +| `value` | `string` | + +#### Defined in + +packages/medusa/dist/types/return-reason.d.ts:1 + +___ + +### CreateReturnType + +Ƭ **CreateReturnType**: [`Omit`](internal-1.md#omit)<[`Return`](../classes/internal-3.Return.md), ``"beforeInsert"``\> + +#### Defined in + +packages/medusa/dist/types/fulfillment-provider.d.ts:6 + +___ + +### CreateSalesChannelInput + +Ƭ **CreateSalesChannelInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description?` | `string` | +| `is_disabled?` | `boolean` | +| `name` | `string` | + +#### Defined in + +packages/medusa/dist/types/sales-channels.d.ts:1 + +___ + +### CreateShipmentConfig + +Ƭ **CreateShipmentConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `location_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/fulfillment.d.ts:10 + +___ + +### CreateShippingMethod + +Ƭ **CreateShippingMethod**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart_id?` | `string` | +| `claim_order_id?` | `string` | +| `data?` | `any` | +| `draft_order_id?` | `string` | +| `order_id?` | `string` | +| `price?` | `number` | +| `return_id?` | `string` | +| `shipping_option_id?` | `string` | +| `swap_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:17 + +___ + +### CreateShippingMethodDto + +Ƭ **CreateShippingMethodDto**: [`CreateShippingMethod`](internal-8.md#createshippingmethod) & { `cart?`: [`Cart`](../classes/internal-3.Cart.md) ; `order?`: [`Order`](../classes/internal-3.Order.md) } + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:28 + +___ + +### CreateShippingOptionInput + +Ƭ **CreateShippingOptionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `admin_only?` | `boolean` | +| `amount?` | `number` | +| `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `includes_tax?` | `boolean` | +| `is_return?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | +| `price_type` | [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) | +| `profile_id` | `string` | +| `provider_id` | `string` | +| `region_id` | `string` | +| `requirements?` | [`ShippingOptionRequirement`](../classes/internal-3.ShippingOptionRequirement.md)[] | + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:32 + +___ + +### CreateShippingProfile + +Ƭ **CreateShippingProfile**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | +| `type` | [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) | + +#### Defined in + +packages/medusa/dist/types/shipping-profile.d.ts:2 + +___ + +### CreateStockLocationInput + +Ƭ **CreateStockLocationInput**: `Object` + +**`Schema`** + +CreateStockLocationInput +title: "Create Stock Location Input" +description: "Represents the Input to create a Stock Location" +type: object +required: + - name +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: "#/components/schemas/StockLocationAddressInput" + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address?` | `string` \| [`StockLocationAddressInput`](internal-8.md#stocklocationaddressinput) | +| `address_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:229 + +___ + +### CreateTaxRateInput + +Ƭ **CreateTaxRateInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` | +| `name` | `string` | +| `rate?` | `number` \| ``null`` | +| `region_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/tax-rate.d.ts:17 + +___ + +### CustomerGroupConstructorProps + +Ƭ **CustomerGroupConstructorProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customerGroupRepository` | typeof [`CustomerGroupRepository`](internal-8.md#customergrouprepository) | +| `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/customer-group.d.ts:8 + +___ + +### DefaultWithoutRelations + +Ƭ **DefaultWithoutRelations**: [`Omit`](internal-1.md#omit)<[`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\>, ``"relations"``\> + +#### Defined in + +packages/medusa/dist/repositories/customer-group.d.ts:4 + +___ + +### DefaultWithoutRelations + +Ƭ **DefaultWithoutRelations**: [`Omit`](internal-1.md#omit)<[`ExtendedFindConfig`](internal-8.md#extendedfindconfig)<[`Product`](../classes/internal-3.Product.md)\>, ``"relations"``\> + +#### Defined in + +packages/medusa/dist/repositories/product.d.ts:4 + +___ + +### DeleteFileType + +Ƭ **DeleteFileType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fileKey` | `string` | + +#### Defined in + +packages/types/dist/file-service/index.d.ts:19 + +___ + +### DeleteResponse + +Ƭ **DeleteResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `deleted` | `boolean` | +| `id` | `string` | +| `object` | `string` | + +#### Defined in + +packages/types/dist/common/common.d.ts:97 + +___ + +### Discount + +Ƭ **Discount**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` | + +#### Defined in + +packages/medusa/dist/types/draft-orders.d.ts:26 + +___ + +### DiscountAllocation + +Ƭ **DiscountAllocation**: `Object` + +The amount of a discount allocated to a line item + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `unit_amount` | `number` | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:18 + +___ + +### DiscountConditionInput + +Ƭ **DiscountConditionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer_groups?` | (`string` \| { `id`: `string` })[] | +| `id?` | `string` | +| `operator?` | [`DiscountConditionOperator`](../enums/internal-3.DiscountConditionOperator.md) | +| `product_collections?` | (`string` \| { `id`: `string` })[] | +| `product_tags?` | (`string` \| { `id`: `string` })[] | +| `product_types?` | (`string` \| { `id`: `string` })[] | +| `products?` | (`string` \| { `id`: `string` })[] | +| `rule_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:30 + +___ + +### DiscountConditionResourceType + +Ƭ **DiscountConditionResourceType**: `EntityTarget`<[`DiscountConditionProduct`](../classes/internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductType`](../classes/internal-8.internal.DiscountConditionProductType.md) \| [`DiscountConditionProductCollection`](../classes/internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](../classes/internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionCustomerGroup`](../classes/internal-8.internal.DiscountConditionCustomerGroup.md)\> + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:10 + +___ + +### DraftOrderCreateProps + +Ƭ **DraftOrderCreateProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `billing_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | +| `billing_address_id?` | `string` | +| `customer_id?` | `string` | +| `discounts?` | [`Discount`](internal-8.md#discount)[] | +| `email` | `string` | +| `idempotency_key?` | `string` | +| `items?` | [`Item`](internal-8.md#item)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification_order?` | `boolean` | +| `region_id` | `string` | +| `shipping_address?` | [`Partial`](internal-8.md#partial)<[`AddressPayload`](../classes/internal.AddressPayload.md)\> | +| `shipping_address_id?` | `string` | +| `shipping_methods` | [`ShippingMethod`](internal-8.md#shippingmethod)[] | +| `status?` | `string` | + +#### Defined in + +packages/medusa/dist/types/draft-orders.d.ts:5 + +___ + +### EmitData + +Ƭ **EmitData**<`T`\>: `Object` + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data` | `T` | +| `eventName` | `string` | +| `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +#### Defined in + +packages/types/dist/event-bus/common.d.ts:10 + +___ + +### ExtendedFindConfig + +Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](internal-1.md#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](internal-1.md#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } + +#### Type parameters + +| Name | +| :------ | +| `TEntity` | + +#### Defined in + +packages/types/dist/common/common.d.ts:50 + +___ + +### ExtendedStoreDTO + +Ƭ **ExtendedStoreDTO**: [`Store`](../classes/internal-8.internal.Store.md) & { `feature_flags`: [`FeatureFlagsResponse`](internal-8.md#featureflagsresponse) ; `fulfillment_providers`: [`FulfillmentProvider`](../classes/internal-3.FulfillmentProvider.md)[] ; `modules`: [`ModulesResponse`](internal-8.md#modulesresponse) ; `payment_providers`: [`PaymentProvider`](../classes/internal-3.PaymentProvider.md)[] } + +**`Schema`** + +ExtendedStoreDTO +allOf: + - $ref: "#/components/schemas/Store" + - type: object + required: + - payment_providers + - fulfillment_providers + - feature_flags + - modules + properties: + payment_providers: + $ref: "#/components/schemas/PaymentProvider" + fulfillment_providers: + $ref: "#/components/schemas/FulfillmentProvider" + feature_flags: + $ref: "#/components/schemas/FeatureFlagsResponse" + modules: + $ref: "#/components/schemas/ModulesResponse" + +#### Defined in + +packages/medusa/dist/types/store.d.ts:52 + +___ + +### ExternalModuleDeclaration + +Ƭ **ExternalModuleDeclaration**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `alias?` | `string` | If multiple modules are registered with the same key, the alias can be used to differentiate them | +| `definition?` | [`ModuleDefinition`](internal-8.md#moduledefinition) | - | +| `main?` | `boolean` | If the module is the main module for the key when multiple ones are registered | +| `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | - | +| `scope` | [`EXTERNAL`](internal-8.md#external) | - | +| `server?` | { `keepAlive`: `boolean` ; `type`: ``"http"`` ; `url`: `string` } | - | +| `server.keepAlive` | `boolean` | - | +| `server.type` | ``"http"`` | - | +| `server.url` | `string` | - | + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:33 + +___ + +### FeatureFlagsResponse + +Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| [`Record`](internal.md#record)<`string`, `boolean`\> }[] + +**`Schema`** + +FeatureFlagsResponse +type: array +items: + type: object + required: + - key + - value + properties: + key: + description: The key of the feature flag. + type: string + value: + description: The value of the feature flag. + type: boolean + +#### Defined in + +packages/medusa/dist/types/feature-flags.d.ts:21 + +___ + +### FeatureFlagsResponse + +Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| [`Record`](internal.md#record)<`string`, `boolean`\> }[] + +**`Schema`** + +FeatureFlagsResponse +type: array +items: + type: object + required: + - key + - value + properties: + key: + description: The key of the feature flag. + type: string + value: + description: The value of the feature flag. + type: boolean + +#### Defined in + +packages/types/dist/feature-flag/common.d.ts:21 + +___ + +### FileServiceGetUploadStreamResult + +Ƭ **FileServiceGetUploadStreamResult**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fileKey` | `string` | +| `promise` | `Promise`<`any`\> | +| `url` | `string` | +| `writeStream` | [`PassThrough`](../classes/internal-8.PassThrough.md) | + +#### Defined in + +packages/types/dist/file-service/index.d.ts:7 + +___ + +### FileServiceUploadResult + +Ƭ **FileServiceUploadResult**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `key` | `string` | +| `url` | `string` | + +#### Defined in + +packages/types/dist/file-service/index.d.ts:3 + +___ + +### FilterableInventoryItemProps + +Ƭ **FilterableInventoryItemProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `hs_code?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | +| `id?` | `string` \| `string`[] | +| `location_id?` | `string` \| `string`[] | +| `origin_country?` | `string` \| `string`[] | +| `q?` | `string` | +| `requires_shipping?` | `boolean` | +| `sku?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:204 + +___ + +### FilterableInventoryLevelProps + +Ƭ **FilterableInventoryLevelProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `incoming_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | +| `inventory_item_id?` | `string` \| `string`[] | +| `location_id?` | `string` \| `string`[] | +| `reserved_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | +| `stocked_quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:239 + +___ + +### FilterableReservationItemProps + +Ƭ **FilterableReservationItemProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `created_by?` | `string` \| `string`[] | +| `description?` | `string` \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | +| `id?` | `string` \| `string`[] | +| `inventory_item_id?` | `string` \| `string`[] | +| `line_item_id?` | `string` \| `string`[] | +| `location_id?` | `string` \| `string`[] | +| `quantity?` | `number` \| [`NumericalComparisonOperator`](../interfaces/internal-8.NumericalComparisonOperator.md) | +| `type?` | `string` \| `string`[] | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:194 + +___ + +### FilterableStockLocationProps + +Ƭ **FilterableStockLocationProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id?` | `string` \| `string`[] | +| `name?` | `string` \| `string`[] \| [`StringComparisonOperator`](../interfaces/internal-8.StringComparisonOperator.md) | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:149 + +___ + +### FilterableTaxRateProps + +Ƭ **FilterableTaxRateProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code?` | `string` \| `string`[] \| [`StringComparisonOperator`](../classes/internal-6.StringComparisonOperator.md) | +| `created_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | +| `deleted_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | +| `name?` | `string` \| `string`[] | +| `rate?` | `number` \| [`NumericalComparisonOperator`](../classes/internal-8.internal.NumericalComparisonOperator.md) | +| `region_id?` | `string` \| `string`[] | +| `updated_at?` | `Date` \| [`DateComparisonOperator`](../classes/internal-2.DateComparisonOperator.md) | + +#### Defined in + +packages/medusa/dist/types/tax-rate.d.ts:2 + +___ + +### FilterableUserProps + +Ƭ **FilterableUserProps**: [`PartialPick`](internal-8.internal.md#partialpick)<[`User`](../classes/internal-1.User.md), ``"email"`` \| ``"first_name"`` \| ``"last_name"`` \| ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\> + +#### Defined in + +packages/medusa/dist/types/user.d.ts:26 + +___ + +### FindProductConfig + +Ƭ **FindProductConfig**: [`FindConfig`](../interfaces/internal-8.internal.FindConfig.md)<[`Product`](../classes/internal-3.Product.md)\> & [`PriceListLoadConfig`](internal-8.internal.md#pricelistloadconfig) + +#### Defined in + +packages/medusa/dist/types/product.d.ts:146 + +___ + +### FindWithRelationsOptions + +Ƭ **FindWithRelationsOptions**: `FindManyOptions`<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> & { `order?`: `FindOptionsOrder`<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> ; `withDeleted?`: `boolean` } + +#### Defined in + +packages/medusa/dist/repositories/product-variant.d.ts:4 + +___ + +### FindWithoutRelationsOptions + +Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations) & { `where`: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations)[``"where"``] & { `discount_condition_id?`: `string` \| `FindOperator`<`string`\> } } + +#### Defined in + +packages/medusa/dist/repositories/customer-group.d.ts:5 + +___ + +### FindWithoutRelationsOptions + +Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations-1) & { `where`: [`DefaultWithoutRelations`](internal-8.md#defaultwithoutrelations-1)[``"where"``] & { `categories?`: `FindOptionsWhere`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `category_id?`: [`CategoryQueryParams`](internal-8.md#categoryqueryparams) ; `discount_condition_id?`: `string` ; `include_category_children?`: `boolean` ; `price_list_id?`: `FindOperator`<[`PriceList`](../classes/internal-3.PriceList.md)\> ; `sales_channel_id?`: `FindOperator`<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\> ; `tags?`: `FindOperator`<[`ProductTag`](../classes/internal-3.ProductTag.md)\> } } + +#### Defined in + +packages/medusa/dist/repositories/product.d.ts:8 + +___ + +### FulFillmentItemType + +Ƭ **FulFillmentItemType**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `item_id` | `string` | +| `quantity` | `number` | + +#### Defined in + +packages/medusa/dist/types/fulfillment.d.ts:2 + +___ + +### FulfillmentItemPartition + +Ƭ **FulfillmentItemPartition**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `items` | [`LineItem`](../classes/internal-3.LineItem.md)[] | +| `shipping_method` | [`ShippingMethod`](../classes/internal-3.ShippingMethod.md) | + +#### Defined in + +packages/medusa/dist/types/fulfillment.d.ts:6 + +___ + +### FulfillmentOptions + +Ƭ **FulfillmentOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `options` | [`Record`](internal.md#record)<`string`, `unknown`\>[] | +| `provider_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/fulfillment-provider.d.ts:2 + +___ + +### FulfillmentProviderContainer + +Ƭ **FulfillmentProviderContainer**: [`MedusaContainer`](internal-8.internal.md#medusacontainer) & { `fulfillmentProviderRepository`: typeof [`FulfillmentProviderRepository`](internal-8.md#fulfillmentproviderrepository) ; `manager`: `EntityManager` } & { [key in \`${FulfillmentProviderKey}\`]: typeof BaseFulfillmentService } + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:10 + +___ + +### FulfillmentProviderData + +Ƭ **FulfillmentProviderData**: [`Record`](internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:4 + +___ + +### FulfillmentProviderKey + +Ƭ **FulfillmentProviderKey**: \`fp\_${string}\` + +#### Defined in + +packages/medusa/dist/services/fulfillment-provider.d.ts:9 + +___ + +### GenerateInputData + +Ƭ **GenerateInputData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `quantity` | `number` | +| `unit_price?` | `number` | +| `variantId` | `string` | + +#### Defined in + +packages/medusa/dist/types/line-item.d.ts:2 + +___ + +### GenerateLineItemContext + +Ƭ **GenerateLineItemContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cart?` | [`CalculationContextData`](internal-8.md#calculationcontextdata) | +| `customer_id?` | `string` | +| `includes_tax?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `order_edit_id?` | `string` | +| `region_id?` | `string` | +| `unit_price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/line-item.d.ts:8 + +___ + +### GeneratedAdjustment + +Ƭ **GeneratedAdjustment**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `description` | `string` | +| `discount_id` | `string` | + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:19 + +___ + +### GetLineItemTotalOptions + +Ƭ **GetLineItemTotalOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exclude_discounts?` | `boolean` | +| `include_tax?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:39 + +___ + +### GetRegionPriceContext + +Ƭ **GetRegionPriceContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customer_id?` | `string` | +| `include_discount_prices?` | `boolean` | +| `quantity?` | `number` | +| `regionId` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:11 + +___ + +### GetShippingMethodTotalsOptions + +Ƭ **GetShippingMethodTotalsOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculation_context?` | [`TaxCalculationContext`](internal-8.internal.md#taxcalculationcontext) | +| `include_tax?` | `boolean` | +| `use_tax_lines?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:16 + +___ + +### GetTotalsOptions + +Ƭ **GetTotalsOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `exclude_gift_cards?` | `boolean` | +| `force_taxes?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:50 + +___ + +### GetUploadedFileType + +Ƭ **GetUploadedFileType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fileKey` | `string` | +| `isPrivate?` | `boolean` | + +#### Defined in + +packages/types/dist/file-service/index.d.ts:14 + +___ + +### GiftCardAllocation + +Ƭ **GiftCardAllocation**: `Object` + +The amount of a gift card allocated to a line item + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `unit_amount` | `number` | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:13 + +___ + +### GiftCardTransaction + +Ƭ **GiftCardTransaction**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `gift_card` | [`GiftCard`](../classes/internal-3.GiftCard.md) | +| `is_taxable` | `boolean` \| ``null`` | +| `tax_rate` | `number` \| ``null`` | + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:19 + +___ + +### HttpCompressionOptions + +Ƭ **HttpCompressionOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `enabled?` | `boolean` | +| `level?` | `number` | +| `memLevel?` | `number` | +| `threshold?` | `number` \| `string` | + +#### Defined in + +packages/types/dist/common/config-module.d.ts:12 + +___ + +### IdempotencyCallbackResult + +Ƭ **IdempotencyCallbackResult**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `recovery_point?` | `string` | +| `response_body?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `response_code?` | `number` | + +#### Defined in + +packages/medusa/dist/types/idempotency-key.d.ts:7 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `analyticsConfigRepository` | typeof [`AnalyticsConfigRepository`](internal-8.md#analyticsconfigrepository) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/analytics-config.d.ts:7 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | +| `manager` | `EntityManager` | +| `userService` | [`UserService`](../classes/internal-8.internal.UserService.md) | + +#### Defined in + +packages/medusa/dist/services/auth.d.ts:6 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `batchJobRepository` | typeof [`BatchJobRepository`](internal-8.md#batchjobrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `strategyResolverService` | [`StrategyResolverService`](../classes/internal-8.internal.StrategyResolverService.md) | + +#### Defined in + +packages/medusa/dist/services/batch-job.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | +| `cartRepository` | typeof [`CartRepository`](internal-8.md#cartrepository) | +| `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | +| `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | +| `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `giftCardService` | [`GiftCardService`](../classes/internal-8.internal.GiftCardService.md) | +| `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | +| `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `paymentSessionRepository` | typeof [`PaymentSessionRepository`](internal-8.md#paymentsessionrepository) | +| `priceSelectionStrategy` | [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) | +| `pricingService` | [`PricingService`](../classes/internal-8.internal.PricingService.md) | +| `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `salesChannelService` | [`SalesChannelService`](../classes/internal-8.internal.SalesChannelService.md) | +| `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | +| `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:13 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | +| `claimItemService` | [`ClaimItemService`](../classes/internal-8.internal.ClaimItemService.md) | +| `claimRepository` | typeof [`ClaimRepository`](internal-8.md#claimrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | +| `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `returnService` | [`ReturnService`](../classes/internal-8.internal.ReturnService.md) | +| `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/claim.d.ts:22 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/currency.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customShippingOptionRepository` | typeof [`CustomShippingOptionRepository`](internal-8.md#customshippingoptionrepository) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/custom-shipping-option.d.ts:7 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | +| `customerRepository` | typeof [`CustomerRepository`](internal-8.md#customerrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/customer.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discountConditionRepository` | typeof [`DiscountConditionRepository`](internal-8.md#discountconditionrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/discount-condition.d.ts:8 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | +| `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | +| `draftOrderRepository` | typeof [`DraftOrderRepository`](internal-8.md#draftorderrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `orderRepository` | typeof [`OrderRepository`](internal-8.md#orderrepository) | +| `paymentRepository` | typeof [`PaymentRepository`](internal-8.md#paymentrepository) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | + +#### Defined in + +packages/medusa/dist/services/draft-order.d.ts:15 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusModuleService` | [`AbstractEventBusModuleService`](../classes/internal-8.AbstractEventBusModuleService.md) | +| `logger` | [`Logger`](../interfaces/internal-8.Logger.md) | +| `stagedJobService` | [`StagedJobService`](../classes/internal-8.internal.StagedJobService.md) | + +#### Defined in + +packages/medusa/dist/services/event-bus.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `giftCardRepository` | typeof [`GiftCardRepository`](internal-8.md#giftcardrepository) | +| `giftCardTransactionRepository` | typeof [`GiftCardTransactionRepository`](internal-8.md#giftcardtransactionrepository) | +| `manager` | `EntityManager` | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | + +#### Defined in + +packages/medusa/dist/services/gift-card.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `idempotencyKeyRepository` | typeof [`IdempotencyKeyRepository`](internal-8.md#idempotencykeyrepository) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/idempotency-key.d.ts:7 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cartRepository` | typeof [`CartRepository`](internal-8.md#cartrepository) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | +| `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | +| `lineItemTaxLineRepository` | typeof [`LineItemTaxLineRepository`](internal-8.md#lineitemtaxlinerepository) | +| `manager` | `EntityManager` | +| `pricingService` | [`PricingService`](../classes/internal-8.internal.PricingService.md) | +| `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/line-item.d.ts:14 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `taxCalculationStrategy` | [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:34 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `noteRepository` | typeof [`NoteRepository`](internal-8.md#noterepository) | + +#### Defined in + +packages/medusa/dist/services/note.d.ts:8 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `logger` | [`Logger`](internal-8.internal.md#logger) | +| `manager` | `EntityManager` | +| `notificationProviderRepository` | typeof [`NotificationProviderRepository`](internal-8.md#notificationproviderrepository) | +| `notificationRepository` | typeof [`NotificationRepository`](internal-8.md#notificationrepository) | + +#### Defined in + +packages/medusa/dist/services/notification.d.ts:8 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: [`MedusaContainer`](internal-8.internal.md#medusacontainer) & { `eventBusService`: [`EventBusService`](../classes/internal-8.internal.EventBusService.md) ; `manager`: `EntityManager` ; `oauthRepository`: typeof [`OauthRepository`](internal-8.md#oauthrepository) } + +#### Defined in + +packages/medusa/dist/services/oauth.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `addressRepository` | typeof [`AddressRepository`](internal-8.md#addressrepository) | +| `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | +| `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | +| `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | +| `draftOrderService` | [`DraftOrderService`](../classes/internal-8.internal.DraftOrderService.md) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | +| `giftCardService` | [`GiftCardService`](../classes/internal-8.internal.GiftCardService.md) | +| `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | +| `orderRepository` | typeof [`OrderRepository`](internal-8.md#orderrepository) | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/order.d.ts:15 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `inventoryService?` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | +| `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | +| `orderEditItemChangeService` | [`OrderEditItemChangeService`](../classes/internal-8.internal.OrderEditItemChangeService.md) | +| `orderEditRepository` | typeof [`OrderEditRepository`](internal-8.md#ordereditrepository) | +| `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/order-edit.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `orderItemChangeRepository` | typeof [`OrderItemChangeRepository`](internal-8.md#orderitemchangerepository) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/order-edit-item-change.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customerService` | [`CustomerService`](../classes/internal-8.internal.CustomerService.md) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `paymentCollectionRepository` | typeof [`PaymentCollectionRepository`](internal-8.md#paymentcollectionrepository) | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/payment-collection.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: { `customerService`: [`CustomerService`](../classes/internal-8.internal.CustomerService.md) ; `featureFlagRouter`: [`FlagRouter`](../classes/internal-8.FlagRouter.md) ; `logger`: [`Logger`](internal-8.internal.md#logger) ; `manager`: `EntityManager` ; `paymentProviderRepository`: typeof [`PaymentProviderRepository`](internal-8.md#paymentproviderrepository) ; `paymentRepository`: typeof [`PaymentRepository`](internal-8.md#paymentrepository) ; `paymentService`: [`PaymentService`](../classes/internal-8.PaymentService.md) ; `paymentSessionRepository`: typeof [`PaymentSessionRepository`](internal-8.md#paymentsessionrepository) ; `refundRepository`: typeof [`RefundRepository`](internal-8.md#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof BasePaymentService } + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:16 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `priceSelectionStrategy` | [`IPriceSelectionStrategy`](../interfaces/internal-8.internal.IPriceSelectionStrategy.md) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/pricing.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `imageRepository` | typeof [`ImageRepository`](internal-8.md#imagerepository) | +| `manager` | `EntityManager` | +| `productCategoryRepository` | typeof [`ProductCategoryRepository`](internal-8.md#productcategoryrepository) | +| `productOptionRepository` | typeof [`ProductOptionRepository`](internal-8.md#productoptionrepository) | +| `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | +| `productTagRepository` | typeof [`ProductTagRepository`](internal-8.md#producttagrepository) | +| `productTypeRepository` | typeof [`ProductTypeRepository`](internal-8.md#producttyperepository) | +| `productVariantRepository` | typeof [`ProductVariantRepository`](internal-8.md#productvariantrepository) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `searchService` | [`SearchService`](../classes/internal-8.internal.SearchService.md) | + +#### Defined in + +packages/medusa/dist/services/product.d.ts:16 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `productCategoryRepository` | typeof [`ProductCategoryRepository`](internal-8.md#productcategoryrepository) | + +#### Defined in + +packages/medusa/dist/services/product-category.d.ts:8 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `productCollectionRepository` | typeof [`ProductCollectionRepository`](internal-8.md#productcollectionrepository) | +| `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | +| `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | +| `manager` | `EntityManager` | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `salesChannelInventoryService` | [`SalesChannelInventoryService`](../classes/internal-8.internal.SalesChannelInventoryService.md) | +| `salesChannelLocationService` | [`SalesChannelLocationService`](../classes/internal-8.internal.SalesChannelLocationService.md) | +| `stockLocationService` | [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) | + +#### Defined in + +packages/medusa/dist/services/product-variant-inventory.d.ts:10 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `countryRepository` | typeof [`CountryRepository`](internal-8.md#countryrepository) | +| `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `fulfillmentProviderRepository` | typeof [`FulfillmentProviderRepository`](internal-8.md#fulfillmentproviderrepository) | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `manager` | `EntityManager` | +| `paymentProviderRepository` | typeof [`PaymentProviderRepository`](internal-8.md#paymentproviderrepository) | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `regionRepository` | typeof [`RegionRepository`](internal-8.md#regionrepository) | +| `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | +| `taxProviderRepository` | typeof [`TaxProviderRepository`](internal-8.md#taxproviderrepository) | + +#### Defined in + +packages/medusa/dist/services/region.d.ts:17 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `returnItemRepository` | typeof [`ReturnItemRepository`](internal-8.md#returnitemrepository) | +| `returnReasonService` | [`ReturnReasonService`](../classes/internal-8.internal.ReturnReasonService.md) | +| `returnRepository` | typeof [`ReturnRepository`](internal-8.md#returnrepository) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/return.d.ts:11 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `manager` | `EntityManager` | +| `returnReasonRepository` | typeof [`ReturnReasonRepository`](internal-8.md#returnreasonrepository) | + +#### Defined in + +packages/medusa/dist/services/return-reason.d.ts:7 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `salesChannelRepository` | typeof [`SalesChannelRepository`](internal-8.md#saleschannelrepository) | +| `storeService` | [`StoreService`](../classes/internal-8.internal.StoreService.md) | + +#### Defined in + +packages/medusa/dist/services/sales-channel.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | +| `inventoryService` | [`IInventoryService`](../interfaces/internal-8.IInventoryService.md) | +| `manager` | `EntityManager` | +| `salesChannelLocationService` | [`SalesChannelLocationService`](../classes/internal-8.internal.SalesChannelLocationService.md) | + +#### Defined in + +packages/medusa/dist/services/sales-channel-inventory.d.ts:5 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`IEventBusService`](../interfaces/internal-8.IEventBusService.md) | +| `manager` | `EntityManager` | +| `salesChannelService` | [`SalesChannelService`](../classes/internal-8.internal.SalesChannelService.md) | +| `stockLocationService` | [`IStockLocationService`](../interfaces/internal-8.IStockLocationService.md) | + +#### Defined in + +packages/medusa/dist/services/sales-channel-location.d.ts:5 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `logger` | [`Logger`](internal-8.internal.md#logger) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/search.d.ts:4 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `manager` | `EntityManager` | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | +| `shippingMethodRepository` | typeof [`ShippingMethodRepository`](internal-8.md#shippingmethodrepository) | +| `shippingOptionRepository` | typeof [`ShippingOptionRepository`](internal-8.md#shippingoptionrepository) | +| `shippingOptionRequirementRepository` | typeof [`ShippingOptionRequirementRepository`](internal-8.md#shippingoptionrequirementrepository) | + +#### Defined in + +packages/medusa/dist/services/shipping-option.d.ts:12 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `productRepository` | typeof [`ProductRepository`](internal-8.md#productrepository) | +| `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `shippingProfileRepository` | typeof [`ShippingProfileRepository`](internal-8.md#shippingprofilerepository) | + +#### Defined in + +packages/medusa/dist/services/shipping-profile.d.ts:12 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currencyRepository` | typeof [`CurrencyRepository`](internal-8.md#currencyrepository) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `storeRepository` | typeof [`StoreRepository`](internal-8.md#storerepository) | + +#### Defined in + +packages/medusa/dist/services/store.d.ts:9 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Index signature + +▪ [key: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/strategy-resolver.d.ts:3 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `configModule` | [`ConfigModule`](internal-8.internal.md#configmodule) | + +#### Defined in + +packages/medusa/dist/services/token.d.ts:4 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `fulfillmentProviderService` | [`FulfillmentProviderService`](../classes/internal-8.internal.FulfillmentProviderService.md) | +| `fulfillmentRepository` | typeof [`FulfillmentRepository`](internal-8.md#fulfillmentrepository) | +| `lineItemRepository` | typeof [`LineItemRepository`](internal-8.md#lineitemrepository) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `shippingProfileService` | [`ShippingProfileService`](../classes/internal-8.internal.ShippingProfileService.md) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | +| `trackingLinkRepository` | typeof [`TrackingLinkRepository`](internal-8.md#trackinglinkrepository) | + +#### Defined in + +packages/medusa/dist/services/fulfillment.d.ts:13 + +___ + +### InjectedDependencies + +Ƭ **InjectedDependencies**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `manager` | `EntityManager` | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `paymentRepository` | typeof [`PaymentRepository`](internal-8.md#paymentrepository) | + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:8 + +___ + +### InjectedProps + +Ƭ **InjectedProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `cartService` | [`CartService`](../classes/internal-8.internal.CartService.md) | +| `customShippingOptionService` | [`CustomShippingOptionService`](../classes/internal-8.internal.CustomShippingOptionService.md) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `fulfillmentService` | [`FulfillmentService`](../classes/internal-8.FulfillmentService.md) | +| `lineItemAdjustmentService` | [`LineItemAdjustmentService`](../classes/internal-8.internal.LineItemAdjustmentService.md) | +| `lineItemService` | [`LineItemService`](../classes/internal-8.internal.LineItemService.md) | +| `manager` | `EntityManager` | +| `orderService` | [`OrderService`](../classes/internal-8.internal.OrderService.md) | +| `paymentProviderService` | [`PaymentProviderService`](../classes/internal-8.internal.PaymentProviderService.md) | +| `productVariantInventoryService` | [`ProductVariantInventoryService`](../classes/internal-8.internal.ProductVariantInventoryService.md) | +| `returnService` | [`ReturnService`](../classes/internal-8.internal.ReturnService.md) | +| `shippingOptionService` | [`ShippingOptionService`](../classes/internal-8.internal.ShippingOptionService.md) | +| `swapRepository` | typeof [`SwapRepository`](internal-8.md#swaprepository) | +| `totalsService` | [`TotalsService`](../classes/internal-8.internal.TotalsService.md) | + +#### Defined in + +packages/medusa/dist/services/swap.d.ts:8 + +___ + +### InternalModuleDeclaration + +Ƭ **InternalModuleDeclaration**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `alias?` | `string` | If multiple modules are registered with the same key, the alias can be used to differentiate them | +| `definition?` | [`ModuleDefinition`](internal-8.md#moduledefinition) | - | +| `dependencies?` | `string`[] | - | +| `main?` | `boolean` | If the module is the main module for the key when multiple ones are registered | +| `options?` | [`Record`](internal.md#record)<`string`, `unknown`\> | - | +| `resolve?` | `string` | - | +| `resources` | [`MODULE_RESOURCE_TYPE`](../enums/internal-8.MODULE_RESOURCE_TYPE.md) | - | +| `scope` | [`INTERNAL`](internal-8.md#internal) | - | + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:17 + +___ + +### InventoryItemDTO + +Ƭ **InventoryItemDTO**: `Object` + +**`Schema`** + +InventoryItemDTO +type: object +required: + - sku +properties: + sku: + description: The Stock Keeping Unit (SKU) code of the Inventory Item. + type: string + hs_code: + description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + origin_country: + description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + mid_code: + description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + title: + description: "Title of the inventory item" + type: string + description: + description: "Description of the inventory item" + type: string + thumbnail: + description: "Thumbnail for the inventory item" + type: string + material: + description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers. + type: string + weight: + description: The weight of the Inventory Item. May be used in shipping rate calculations. + type: number + height: + description: The height of the Inventory Item. May be used in shipping rate calculations. + type: number + width: + description: The width of the Inventory Item. May be used in shipping rate calculations. + type: number + length: + description: The length of the Inventory Item. May be used in shipping rate calculations. + type: number + requires_shipping: + description: Whether the item requires shipping. + type: boolean + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + created_at: + type: string + description: "The date with timezone at which the resource was created." + format: date-time + updated_at: + type: string + description: "The date with timezone at which the resource was updated." + format: date-time + deleted_at: + type: string + description: "The date with timezone at which the resource was deleted." + format: date-time + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `created_at` | `string` \| `Date` | +| `deleted_at` | `string` \| `Date` \| ``null`` | +| `description?` | `string` \| ``null`` | +| `height?` | `number` \| ``null`` | +| `hs_code?` | `string` \| ``null`` | +| `id` | `string` | +| `length?` | `number` \| ``null`` | +| `material?` | `string` \| ``null`` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `mid_code?` | `string` \| ``null`` | +| `origin_country?` | `string` \| ``null`` | +| `requires_shipping` | `boolean` | +| `sku?` | `string` \| ``null`` | +| `thumbnail?` | `string` \| ``null`` | +| `title?` | `string` \| ``null`` | +| `updated_at` | `string` \| `Date` | +| `weight?` | `number` \| ``null`` | +| `width?` | `number` \| ``null`` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:64 + +___ + +### InventoryLevelDTO + +Ƭ **InventoryLevelDTO**: `Object` + +**`Schema`** + +InventoryLevelDTO +type: object +required: + - inventory_item_id + - location_id + - stocked_quantity + - reserved_quantity + - incoming_quantity +properties: + location_id: + description: the item location ID + type: string + stocked_quantity: + description: the total stock quantity of an inventory item at the given location ID + type: number + reserved_quantity: + description: the reserved stock quantity of an inventory item at the given location ID + type: number + incoming_quantity: + description: the incoming stock quantity of an inventory item at the given location ID + type: number + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + created_at: + type: string + description: "The date with timezone at which the resource was created." + format: date-time + updated_at: + type: string + description: "The date with timezone at which the resource was updated." + format: date-time + deleted_at: + type: string + description: "The date with timezone at which the resource was deleted." + format: date-time + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `created_at` | `string` \| `Date` | +| `deleted_at` | `string` \| `Date` \| ``null`` | +| `id` | `string` | +| `incoming_quantity` | `number` | +| `inventory_item_id` | `string` | +| `location_id` | `string` | +| `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `reserved_quantity` | `number` | +| `stocked_quantity` | `number` | +| `updated_at` | `string` \| `Date` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:182 + +___ + +### Item + +Ƭ **Item**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `quantity` | `number` | +| `title?` | `string` | +| `unit_price?` | `number` | +| `variant_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/draft-orders.d.ts:29 + +___ + +### IteratorResult + +Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../interfaces/internal-8.IteratorYieldResult.md)<`T`\> \| [`IteratorReturnResult`](../interfaces/internal-8.IteratorReturnResult.md)<`TReturn`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `T` | +| `TReturn` | `any` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2015.iterable.d.ts:39 + +___ + +### JoinerRelationship + +Ƭ **JoinerRelationship**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `alias` | `string` | - | +| `args?` | [`Record`](internal.md#record)<`string`, `any`\> | Extra arguments to pass to the remoteFetchData callback | +| `foreignKey` | `string` | - | +| `inverse?` | `boolean` | In an inverted relationship the foreign key is on the other service and the primary key is on the current service | +| `isInternalService?` | `boolean` | If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more "internal" services | +| `isList?` | `boolean` | Force the relationship to return a list | +| `primaryKey` | `string` | - | +| `serviceName` | `string` | - | + +#### Defined in + +packages/types/dist/joiner/index.d.ts:1 + +___ + +### LineAllocationsMap + +Ƭ **LineAllocationsMap**: `Object` + +A map of line item ids and its corresponding gift card and discount +allocations + +#### Index signature + +▪ [K: `string`]: { `discount?`: [`DiscountAllocation`](internal-8.md#discountallocation) ; `gift_card?`: [`GiftCardAllocation`](internal-8.md#giftcardallocation) } + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:26 + +___ + +### LineDiscount + +Ƭ **LineDiscount**: `Object` + +Associates a line item and discount allocation. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `lineItem` | [`LineItem`](../classes/internal-3.LineItem.md) | +| `variant` | `string` | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:41 + +___ + +### LineDiscountAmount + +Ƭ **LineDiscountAmount**: `Object` + +Associates a line item and discount allocation. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `customAdjustmentsAmount` | `number` | +| `item` | [`LineItem`](../classes/internal-3.LineItem.md) | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:49 + +___ + +### LineItemAdjustmentServiceProps + +Ƭ **LineItemAdjustmentServiceProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discountService` | [`DiscountService`](../classes/internal-8.internal.DiscountService.md) | +| `lineItemAdjustmentRepository` | typeof [`LineItemAdjustmentRepository`](internal-8.md#lineitemadjustmentrepository) | +| `manager` | `EntityManager` | + +#### Defined in + +packages/medusa/dist/services/line-item-adjustment.d.ts:9 + +___ + +### LineItemTotals + +Ƭ **LineItemTotals**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount_total` | `number` | +| `original_tax_total` | `number` | +| `original_total` | `number` | +| `quantity` | `number` | +| `raw_discount_total` | `number` | +| `subtotal` | `number` | +| `tax_lines` | [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[] | +| `tax_total` | `number` | +| `total` | `number` | +| `unit_price` | `number` | + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:7 + +___ + +### LineItemTotals + +Ƭ **LineItemTotals**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `discount_total` | `number` | +| `original_tax_total` | `number` | +| `original_total` | `number` | +| `quantity` | `number` | +| `raw_discount_total` | `number` | +| `subtotal` | `number` | +| `tax_lines` | [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[] | +| `tax_total` | `number` | +| `total` | `number` | +| `unit_price` | `number` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:21 + +___ + +### LineItemTotalsOptions + +Ƭ **LineItemTotalsOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculation_context?` | [`TaxCalculationContext`](internal-8.internal.md#taxcalculationcontext) | +| `exclude_gift_cards?` | `boolean` | +| `include_tax?` | `boolean` | +| `use_tax_lines?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:33 + +___ + +### LineItemUpdate + +Ƭ **LineItemUpdate**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `quantity?` | `number` | +| `region_id?` | `string` | +| `should_calculate_prices?` | `boolean` | +| `title?` | `string` | +| `unit_price?` | `number` | +| `variant_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:10 + +___ + +### LineItemValidateData + +Ƭ **LineItemValidateData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `variant?` | { `product_id`: `string` } | +| `variant.product_id` | `string` | +| `variant_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/cart.d.ts:19 + +___ + +### ListAndCountSelector + +Ƭ **ListAndCountSelector**: [`Selector`](internal-8.internal.md#selector)<[`ProductCollection`](../classes/internal-3.ProductCollection.md)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } + +#### Defined in + +packages/medusa/dist/services/product-collection.d.ts:15 + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](internal-8.md#medusacontainer) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-8.md#medusacontainer) } + +#### Defined in + +packages/types/dist/common/medusa-container.d.ts:2 + +___ + +### MedusaContainer + +Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](internal-8.md#medusacontainer-1) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-8.md#medusacontainer-1) } + +#### Defined in + +packages/medusa-core-utils/dist/medusa-container.d.ts:2 + +___ + +### ModuleDefinition + +Ƭ **ModuleDefinition**: `Object` + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `canOverride?` | `boolean` | **`Deprecated`** property will be removed in future versions | +| `defaultModuleDeclaration` | [`InternalModuleDeclaration`](internal-8.md#internalmoduledeclaration) \| [`ExternalModuleDeclaration`](internal-8.md#externalmoduledeclaration) | - | +| `defaultPackage` | `string` \| ``false`` | - | +| `dependencies?` | `string`[] | - | +| `isLegacy?` | `boolean` | - | +| `isQueryable?` | `boolean` | - | +| `isRequired?` | `boolean` | **`Deprecated`** property will be removed in future versions | +| `key` | `string` | - | +| `label` | `string` | - | +| `registrationName` | `string` | - | + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:59 + +___ + +### ModuleJoinerConfig + +Ƭ **ModuleJoinerConfig**: [`Omit`](internal-1.md#omit)<[`JoinerServiceConfig`](../interfaces/internal-8.JoinerServiceConfig.md), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: [`Record`](internal.md#record)<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `type`: ``"date"`` \| ``"time"`` \| ``"datetime"`` \| ``"bigint"`` \| ``"blob"`` \| ``"uint8array"`` \| ``"array"`` \| ``"enumArray"`` \| ``"enum"`` \| ``"json"`` \| ``"integer"`` \| ``"smallint"`` \| ``"tinyint"`` \| ``"mediumint"`` \| ``"float"`` \| ``"double"`` \| ``"boolean"`` \| ``"decimal"`` \| ``"string"`` \| ``"uuid"`` \| ``"text"`` }\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: [`Record`](internal.md#record)<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](internal-8.md#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: [`Record`](internal.md#record)<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](internal-8.md#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` } + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:104 + +___ + +### ModuleJoinerRelationship + +Ƭ **ModuleJoinerRelationship**: [`JoinerRelationship`](internal-8.md#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` } + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:152 + +___ + +### ModulesResponse + +Ƭ **ModulesResponse**: [`ModulesResponse`](internal-8.md#modulesresponse-1) + +**`Schema`** + +ModulesResponse +type: array +items: + type: object + required: + - module + - resolution + properties: + module: + description: The key of the module. + type: string + resolution: + description: The resolution path of the module or false if module is not installed. + type: string + +#### Defined in + +packages/medusa/dist/types/store.d.ts:30 + +___ + +### ModulesResponse + +Ƭ **ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[] + +#### Defined in + +packages/types/dist/modules-sdk/index.d.ts:100 + +___ + +### OrdersReturnItem + +Ƭ **OrdersReturnItem**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `item_id` | `string` | +| `note?` | `string` | +| `quantity` | `number` | +| `reason_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/return.d.ts:1 + +___ + +### PaginatedResponse + +Ƭ **PaginatedResponse**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `count` | `number` | +| `limit` | `number` | +| `offset` | `number` | + +#### Defined in + +packages/types/dist/common/common.d.ts:92 + +___ + +### Partial + +Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } + +Make all properties in T optional + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1571 + +___ + +### PaymentCollectionsSessionsBatchInput + +Ƭ **PaymentCollectionsSessionsBatchInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `provider_id` | `string` | +| `session_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/payment-collection.d.ts:11 + +___ + +### PaymentCollectionsSessionsInput + +Ƭ **PaymentCollectionsSessionsInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `provider_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/payment-collection.d.ts:16 + +___ + +### PaymentDataInput + +Ƭ **PaymentDataInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `currency_code` | `string` | +| `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `provider_id` | `string` | + +#### Defined in + +packages/medusa/dist/services/payment.d.ts:14 + +___ + +### PaymentProviderKey + +Ƭ **PaymentProviderKey**: \`pp\_${string}\` \| ``"systemPaymentProviderService"`` + +#### Defined in + +packages/medusa/dist/services/payment-provider.d.ts:15 + +___ + +### PaymentSessionInput + +Ƭ **PaymentSessionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `cart` | [`Cart`](../classes/internal-3.Cart.md) \| { `billing_address?`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `context`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `email`: `string` ; `id`: `string` ; `shipping_address`: [`Address`](../classes/internal-3.Address.md) \| ``null`` ; `shipping_methods`: [`ShippingMethod`](../classes/internal-3.ShippingMethod.md)[] } | +| `currency_code` | `string` | +| `customer?` | [`Customer`](../classes/internal-3.Customer.md) \| ``null`` | +| `paymentSessionData?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `payment_session_id?` | `string` | +| `provider_id` | `string` | +| `resource_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/payment.d.ts:2 + +___ + +### Price + +Ƭ **Price**: [`Partial`](internal-8.md#partial)<[`Omit`](internal-1.md#omit)<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md), ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\>\> & { `amount`: `number` } + +#### Defined in + +packages/medusa/dist/repositories/money-amount.d.ts:5 + +___ + +### PriceListConstructorProps + +Ƭ **PriceListConstructorProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `customerGroupService` | [`CustomerGroupService`](../classes/internal-8.internal.CustomerGroupService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `moneyAmountRepository` | typeof [`MoneyAmountRepository`](internal-8.md#moneyamountrepository) | +| `priceListRepository` | typeof [`PriceListRepository`](internal-8.md#pricelistrepository) | +| `productService` | [`ProductService`](../classes/internal-8.internal.ProductService.md) | +| `productVariantRepository` | typeof [`ProductVariantRepository`](internal-8.md#productvariantrepository) | +| `productVariantService` | [`ProductVariantService`](../classes/internal-8.internal.ProductVariantService.md) | +| `regionService` | [`RegionService`](../classes/internal-8.internal.RegionService.md) | + +#### Defined in + +packages/medusa/dist/services/price-list.d.ts:16 + +___ + +### PricedProduct + +Ƭ **PricedProduct**: [`Omit`](internal-1.md#omit)<[`Partial`](internal-8.md#partial)<[`Product`](../classes/internal-3.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-8.md#pricedvariant)[] } + +**`Schema`** + +PricedProduct +title: "Priced Product" +type: object +allOf: + - $ref: "#/components/schemas/Product" + - type: object + properties: + variants: + type: array + items: + $ref: "#/components/schemas/PricedVariant" + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:115 + +___ + +### PricedShippingOption + +Ƭ **PricedShippingOption**: [`Partial`](internal-8.md#partial)<[`ShippingOption`](../classes/internal-3.ShippingOption.md)\> & [`ShippingOptionPricing`](internal-8.md#shippingoptionpricing) + +**`Schema`** + +PricedShippingOption +title: "Priced Shipping Option" +type: object +allOf: + - $ref: "#/components/schemas/ShippingOption" + - type: object + properties: + price_incl_tax: + type: number + description: Price including taxes + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate + tax_amount: + type: number + description: The taxes applied. + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:58 + +___ + +### PricedVariant + +Ƭ **PricedVariant**: [`Partial`](internal-8.md#partial)<[`ProductVariant`](../classes/internal-3.ProductVariant.md)\> & [`ProductVariantPricing`](internal-8.md#productvariantpricing) + +**`Schema`** + +PricedVariant +title: "Priced Product Variant" +type: object +allOf: + - $ref: "#/components/schemas/ProductVariant" + - type: object + properties: + original_price: + type: number + description: The original price of the variant without any discounted prices applied. + calculated_price: + type: number + description: The calculated price of the variant. Can be a discounted price. + original_price_incl_tax: + type: number + description: The original price of the variant including taxes. + calculated_price_incl_tax: + type: number + description: The calculated price of the variant including taxes. + original_tax: + type: number + description: The taxes applied on the original price. + calculated_tax: + type: number + description: The taxes applied on the calculated price. + tax_rates: + type: array + description: An array of applied tax rates + items: + type: object + properties: + rate: + type: number + description: The tax rate value + name: + type: string + description: The name of the tax rate + code: + type: string + description: The code of the tax rate + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:101 + +___ + +### PricingContext + +Ƭ **PricingContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `automatic_taxes` | `boolean` | +| `price_selection` | [`PriceSelectionContext`](internal-8.internal.md#priceselectioncontext) | +| `tax_rate` | `number` \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:19 + +___ + +### ProductCategoryInput + +Ƭ **ProductCategoryInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `handle?` | `string` | +| `is_active?` | `boolean` | +| `is_internal?` | `boolean` | +| `parent_category?` | [`ProductCategory`](../classes/internal-3.ProductCategory.md) \| ``null`` | +| `parent_category_id?` | `string` \| ``null`` | +| `rank?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:3 + +___ + +### ProductOptionInput + +Ƭ **ProductOptionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `title` | `string` | +| `values?` | [`ProductOptionValue`](../classes/internal-3.ProductOptionValue.md)[] | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:142 + +___ + +### ProductSelector + +Ƭ **ProductSelector**: [`FilterableProductProps`](../classes/internal-8.FilterableProductProps.md) \| [`Selector`](internal-8.internal.md#selector)<[`Product`](../classes/internal-3.Product.md)\> & { `category_id?`: `string`[] \| `FindOperator`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `discount_condition_id?`: `string` ; `price_list_id?`: `string`[] \| `FindOperator`<[`PriceList`](../classes/internal-3.PriceList.md)\> ; `q?`: `string` ; `sales_channel_id?`: `string`[] \| `FindOperator`<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\> } + +#### Defined in + +packages/medusa/dist/types/product.d.ts:28 + +___ + +### ProductVariantOption + +Ƭ **ProductVariantOption**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `option_id` | `string` | +| `value` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:17 + +___ + +### ProductVariantPrice + +Ƭ **ProductVariantPrice**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `amount` | `number` | +| `currency_code?` | `string` | +| `id?` | `string` | +| `max_quantity?` | `number` | +| `min_quantity?` | `number` | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:3 + +___ + +### ProductVariantPricing + +Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[] } & [`TaxedPricing`](internal-8.md#taxedpricing) + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:4 + +___ + +### ProjectConfigOptions + +Ƭ **ProjectConfigOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `admin_cors?` | `string` | +| `cookie_secret?` | `string` | +| `database_database?` | `string` | +| `database_extra?` | [`Record`](internal.md#record)<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } | +| `database_logging` | `LoggerOptions` | +| `database_schema?` | `string` | +| `database_type?` | `string` | +| `database_url?` | `string` | +| `http_compression?` | [`HttpCompressionOptions`](internal-8.md#httpcompressionoptions) | +| `jwt_secret?` | `string` | +| `redis_options?` | `RedisOptions` | +| `redis_prefix?` | `string` | +| `redis_url?` | `string` | +| `session_options?` | [`SessionOptions`](internal-8.md#sessionoptions) | +| `store_cors?` | `string` | + +#### Defined in + +packages/types/dist/common/config-module.d.ts:18 + +___ + +### PropertyDecorator + +Ƭ **PropertyDecorator**: (`target`: [`Object`](internal-8.md#object), `propertyKey`: `string` \| `symbol`) => `void` + +#### Type declaration + +▸ (`target`, `propertyKey`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `target` | [`Object`](internal-8.md#object) | +| `propertyKey` | `string` \| `symbol` | + +##### Returns + +`void` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.decorators.legacy.d.ts:20 + +___ + +### PropertyKey + +Ƭ **PropertyKey**: `string` \| `number` \| `symbol` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:108 + +___ + +### ProviderLineItemTaxLine + +Ƭ **ProviderLineItemTaxLine**: `Object` + +The tax line properties for a given line item. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| ``null`` | +| `item_id` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | +| `rate` | `number` | + +#### Defined in + +packages/medusa/dist/types/tax-service.d.ts:33 + +___ + +### ProviderShippingMethodTaxLine + +Ƭ **ProviderShippingMethodTaxLine**: `Object` + +The tax line properties for a given shipping method. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| ``null`` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name` | `string` | +| `rate` | `number` | +| `shipping_method_id` | `string` | + +#### Defined in + +packages/medusa/dist/types/tax-service.d.ts:23 + +___ + +### ProviderTaxLine + +Ƭ **ProviderTaxLine**: [`ProviderLineItemTaxLine`](internal-8.md#providerlineitemtaxline) \| [`ProviderShippingMethodTaxLine`](internal-8.md#providershippingmethodtaxline) + +A union type of the possible provider tax lines. + +#### Defined in + +packages/medusa/dist/types/tax-service.d.ts:43 + +___ + +### ReadableStreamController + +Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`T`\> + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:76 + +___ + +### ReadableStreamDefaultReadResult + +Ƭ **ReadableStreamDefaultReadResult**<`T`\>: [`ReadableStreamDefaultReadValueResult`](../interfaces/internal-8.ReadableStreamDefaultReadValueResult.md)<`T`\> \| [`ReadableStreamDefaultReadDoneResult`](../interfaces/internal-8.ReadableStreamDefaultReadDoneResult.md) + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:77 + +___ + +### RegionDetails + +Ƭ **RegionDetails**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `tax_rate` | `number` \| ``null`` | + +#### Defined in + +packages/medusa/dist/services/tax-provider.d.ts:10 + +___ + +### ReorderConditions + +Ƭ **ReorderConditions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `originalParentId` | `string` \| ``null`` | +| `originalRank` | `number` | +| `shouldChangeParent` | `boolean` | +| `shouldChangeRank` | `boolean` | +| `shouldDeleteElement` | `boolean` | +| `shouldIncrementRank` | `boolean` | +| `targetCategoryId` | `string` | +| `targetParentId` | `string` \| ``null`` \| `undefined` | +| `targetRank` | `number` \| `undefined` | + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:27 + +___ + +### RequestContext + +Ƭ **RequestContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `ip` | `string` | + +#### Defined in + +packages/medusa/dist/types/request.d.ts:1 + +___ + +### ReservationItemDTO + +Ƭ **ReservationItemDTO**: `Object` + +**`Schema`** + +ReservationItemDTO +title: "Reservation item" +description: "Represents a reservation of an inventory item at a stock location" +type: object +required: +- id +- location_id +- inventory_item_id +- quantity +properties: + id: + description: "The id of the reservation item" + type: string + location_id: + description: "The id of the location of the reservation" + type: string + inventory_item_id: + description: "The id of the inventory item the reservation relates to" + type: string + description: + description: "Description of the reservation item" + type: string + created_by: + description: "UserId of user who created the reservation item" + type: string + quantity: + description: "The id of the reservation item" + type: number + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + created_at: + type: string + description: "The date with timezone at which the resource was created." + format: date-time + updated_at: + type: string + description: "The date with timezone at which the resource was updated." + format: date-time + deleted_at: + type: string + description: "The date with timezone at which the resource was deleted." + format: date-time + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `created_at` | `string` \| `Date` | +| `created_by?` | `string` \| ``null`` | +| `deleted_at` | `string` \| `Date` \| ``null`` | +| `description?` | `string` \| ``null`` | +| `id` | `string` | +| `inventory_item_id` | `string` | +| `line_item_id?` | `string` \| ``null`` | +| `location_id` | `string` | +| `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `quantity` | `number` | +| `updated_at` | `string` \| `Date` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:130 + +___ + +### ReserveQuantityContext + +Ƭ **ReserveQuantityContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `lineItemId?` | `string` | +| `locationId?` | `string` | +| `salesChannelId?` | `string` \| ``null`` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:267 + +___ + +### ReturnedData + +Ƭ **ReturnedData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `status` | `string` | +| `to` | `string` | + +#### Defined in + +packages/medusa/dist/interfaces/notification-service.d.ts:2 + +___ + +### SessionOptions + +Ƭ **SessionOptions**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `name?` | `string` | +| `resave?` | `boolean` | +| `rolling?` | `boolean` | +| `saveUninitialized?` | `boolean` | +| `secret?` | `string` | +| `ttl?` | `number` | + +#### Defined in + +packages/types/dist/common/config-module.d.ts:4 + +___ + +### SharedContext + +Ƭ **SharedContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `manager?` | `EntityManager` | +| `transactionManager?` | `EntityManager` | + +#### Defined in + +packages/types/dist/shared-context.d.ts:2 + +___ + +### ShippingMethod + +Ƭ **ShippingMethod**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `option_id` | `string` | +| `price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/draft-orders.d.ts:21 + +___ + +### ShippingMethodData + +Ƭ **ShippingMethodData**: [`Record`](internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:6 + +___ + +### ShippingMethodTotals + +Ƭ **ShippingMethodTotals**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `original_tax_total` | `number` | +| `original_total` | `number` | +| `price` | `number` | +| `subtotal` | `number` | +| `tax_lines` | [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[] | +| `tax_total` | `number` | +| `total` | `number` | + +#### Defined in + +packages/medusa/dist/services/new-totals.d.ts:25 + +___ + +### ShippingMethodTotals + +Ƭ **ShippingMethodTotals**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `original_tax_total` | `number` | +| `original_total` | `number` | +| `price` | `number` | +| `subtotal` | `number` | +| `tax_lines` | [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[] | +| `tax_total` | `number` | +| `total` | `number` | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:7 + +___ + +### ShippingMethodUpdate + +Ƭ **ShippingMethodUpdate**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claim_order_id?` | `string` \| ``null`` | +| `data?` | `any` | +| `order_id?` | `string` | +| `price?` | `number` | +| `return_id?` | `string` | +| `swap_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:9 + +___ + +### ShippingOptionData + +Ƭ **ShippingOptionData**: [`Record`](internal.md#record)<`string`, `unknown`\> + +#### Defined in + +packages/medusa/dist/interfaces/fulfillment-service.d.ts:5 + +___ + +### ShippingOptionPricing + +Ƭ **ShippingOptionPricing**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `price_incl_tax` | `number` \| ``null`` | +| `tax_amount` | `number` | +| `tax_rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:24 + +___ + +### StagedJobServiceProps + +Ƭ **StagedJobServiceProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `manager` | `EntityManager` | +| `stagedJobRepository` | typeof [`StagedJobRepository`](internal-8.md#stagedjobrepository) | + +#### Defined in + +packages/medusa/dist/services/staged-job.d.ts:7 + +___ + +### StockLocationAddressDTO + +Ƭ **StockLocationAddressDTO**: `Object` + +**`Schema`** + +StockLocationAddressDTO +title: "Stock Location Address" +description: "Represents a Stock Location Address" +type: object +required: + - address_1 + - country_code + - created_at + - updated_at +properties: + id: + type: string + description: The stock location address' ID + example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42 + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + company: + type: string + description: Stock location company' name + example: Medusa + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + created_at: + type: string + description: "The date with timezone at which the resource was created." + format: date-time + updated_at: + type: string + description: "The date with timezone at which the resource was updated." + format: date-time + deleted_at: + type: string + description: "The date with timezone at which the resource was deleted." + format: date-time + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address_1` | `string` | +| `address_2?` | `string` \| ``null`` | +| `city?` | `string` \| ``null`` | +| `company?` | `string` \| ``null`` | +| `country_code` | `string` | +| `created_at` | `string` \| `Date` | +| `deleted_at` | `string` \| `Date` \| ``null`` | +| `id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `phone?` | `string` \| ``null`` | +| `postal_code?` | `string` \| ``null`` | +| `province?` | `string` \| ``null`` | +| `updated_at` | `string` \| `Date` | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:66 + +___ + +### StockLocationAddressInput + +Ƭ **StockLocationAddressInput**: `Object` + +**`Schema`** + +StockLocationAddressInput +title: "Stock Location Address Input" +description: "Represents a Stock Location Address Input" +type: object +required: + - address_1 + - country_code +properties: + address_1: + type: string + description: Stock location address + example: 35, Jhon Doe Ave + address_2: + type: string + description: Stock location address' complement + example: apartment 4432 + city: + type: string + description: Stock location address' city + example: Mexico city + country_code: + type: string + description: Stock location address' country + example: MX + phone: + type: string + description: Stock location address' phone number + example: +1 555 61646 + postal_code: + type: string + description: Stock location address' postal code + example: HD3-1G8 + province: + type: string + description: Stock location address' province + example: Sinaloa + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address_1` | `string` | +| `address_2?` | `string` | +| `city?` | `string` | +| `country_code` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `phone?` | `string` | +| `postal_code?` | `string` | +| `province?` | `string` | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:195 + +___ + +### StockLocationDTO + +Ƭ **StockLocationDTO**: `Object` + +**`Schema`** + +StockLocationDTO +title: "Stock Location" +description: "Represents a Stock Location" +type: object +required: + - id + - name + - address_id + - created_at + - updated_at +properties: + id: + type: string + description: The stock location's ID + example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42 + address_id: + type: string + description: Stock location address' ID + example: laddr_05B2ZE853Y6FTXWPW85NJ81A44 + name: + type: string + description: The name of the stock location + example: Main Warehouse + address: + description: "The Address of the Stock Location" + allOf: + - $ref: "#/components/schemas/StockLocationAddressDTO" + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + created_at: + type: string + description: "The date with timezone at which the resource was created." + format: date-time + updated_at: + type: string + description: "The date with timezone at which the resource was updated." + format: date-time + deleted_at: + type: string + description: "The date with timezone at which the resource was deleted." + format: date-time + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address?` | [`StockLocationAddressDTO`](internal-8.md#stocklocationaddressdto) | +| `address_id` | `string` | +| `created_at` | `string` \| `Date` | +| `deleted_at` | `string` \| `Date` \| ``null`` | +| `id` | `string` | +| `metadata` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `name` | `string` | +| `updated_at` | `string` \| `Date` | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:127 + +___ + +### StockLocationExpandedDTO + +Ƭ **StockLocationExpandedDTO**: [`StockLocationDTO`](internal-8.md#stocklocationdto) & { `sales_channels?`: `any`[] } + +**`Schema`** + +StockLocationExpandedDTO +allOf: + - $ref: "#/components/schemas/StockLocationDTO" + - type: object + properties: + sales_channels: + $ref: "#/components/schemas/SalesChannel" + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:146 + +___ + +### Subscriber + +Ƭ **Subscriber**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\> + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `T` | `unknown` | + +#### Type declaration + +▸ (`data`, `eventName`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `data` | `T` | +| `eventName` | `string` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/types/dist/event-bus/common.d.ts:1 + +___ + +### SubscriberContext + +Ƭ **SubscriberContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `subscriberId` | `string` | + +#### Defined in + +packages/types/dist/event-bus/common.d.ts:2 + +___ + +### SubscriberDescriptor + +Ƭ **SubscriberDescriptor**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `subscriber` | [`Subscriber`](internal-8.md#subscriber) | + +#### Defined in + +packages/types/dist/event-bus/common.d.ts:5 + +___ + +### SubtotalOptions + +Ƭ **SubtotalOptions**: `Object` + +Options to use for subtotal calculations + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `excludeNonDiscounts?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/totals.d.ts:35 + +___ + +### TaxLinesMaps + +Ƭ **TaxLinesMaps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `lineItemsTaxLines` | { `[lineItemId: string]`: [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]; } | +| `shippingMethodsTaxLines` | { `[shippingMethodId: string]`: [`ShippingMethodTaxLine`](../classes/internal-3.ShippingMethodTaxLine.md)[]; } | + +#### Defined in + +packages/medusa/dist/types/tax-service.d.ts:2 + +___ + +### TaxRateListByConfig + +Ƭ **TaxRateListByConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/tax-rate.d.ts:23 + +___ + +### TaxServiceRate + +Ƭ **TaxServiceRate**: `Object` + +The tax rate object as configured in Medusa. These may have an unspecified +numerical rate as they may be used for lookup purposes in the tax provider +plugin. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code` | `string` \| ``null`` | +| `name` | `string` | +| `rate?` | `number` \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/tax-service.d.ts:15 + +___ + +### TaxedPricing + +Ƭ **TaxedPricing**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `calculated_price_incl_tax` | `number` \| ``null`` | +| `calculated_tax` | `number` \| ``null`` | +| `original_price_incl_tax` | `number` \| ``null`` | +| `original_tax` | `number` \| ``null`` | +| `tax_rates` | [`TaxServiceRate`](internal-8.md#taxservicerate)[] \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/pricing.d.ts:12 + +___ + +### TotalsConfig + +Ƭ **TotalsConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `force_taxes?` | `boolean` | + +#### Defined in + +packages/medusa/dist/services/cart.d.ts:43 + +___ + +### TotalsContext + +Ƭ **TotalsContext**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `force_taxes?` | `boolean` | +| `includes?` | { `returnable_items?`: `boolean` } | +| `includes.returnable_items?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:4 + +___ + +### TotalsServiceProps + +Ƭ **TotalsServiceProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `newTotalsService` | [`NewTotalsService`](../classes/internal-8.internal.NewTotalsService.md) | +| `taxCalculationStrategy` | [`ITaxCalculationStrategy`](../interfaces/internal-8.internal.ITaxCalculationStrategy.md) | +| `taxProviderService` | [`TaxProviderService`](../classes/internal-8.internal.TaxProviderService.md) | + +#### Defined in + +packages/medusa/dist/services/totals.d.ts:43 + +___ + +### TransformCallback + +Ƭ **TransformCallback**: (`error?`: [`Error`](internal-8.md#error) \| ``null``, `data?`: `any`) => `void` + +#### Type declaration + +▸ (`error?`, `data?`): `void` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `error?` | [`Error`](internal-8.md#error) \| ``null`` | +| `data?` | `any` | + +##### Returns + +`void` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream.d.ts:1044 + +___ + +### Transformer + +Ƭ **Transformer**: (`item?`: [`LineItem`](../classes/internal-3.LineItem.md), `quantity?`: `number`, `additional?`: [`OrdersReturnItem`](../classes/internal-8.OrdersReturnItem.md)) => `Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> + +#### Type declaration + +▸ (`item?`, `quantity?`, `additional?`): `Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `item?` | [`LineItem`](../classes/internal-3.LineItem.md) | +| `quantity?` | `number` | +| `additional?` | [`OrdersReturnItem`](../classes/internal-8.OrdersReturnItem.md) | + +##### Returns + +`Promise`<`DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\>\> \| `DeepPartial`<[`LineItem`](../classes/internal-3.LineItem.md)\> + +#### Defined in + +packages/medusa/dist/services/return.d.ts:25 + +___ + +### TypedArray + +Ƭ **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` + +#### Defined in + +packages/medusa-js/node_modules/@types/node/globals.d.ts:239 + +___ + +### UpdateAnalyticsConfig + +Ƭ **UpdateAnalyticsConfig**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `anonymize?` | `boolean` | +| `opt_out?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/analytics-config.d.ts:5 + +___ + +### UpdateClaimInput + +Ƭ **UpdateClaimInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `claim_items?` | [`UpdateClaimItemInput`](internal-8.md#updateclaimiteminput)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | +| `shipping_methods?` | [`UpdateClaimShippingMethodInput`](internal-8.md#updateclaimshippingmethodinput)[] | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:42 + +___ + +### UpdateClaimItemImageInput + +Ƭ **UpdateClaimItemImageInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id?` | `string` | +| `url?` | `string` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:62 + +___ + +### UpdateClaimItemInput + +Ƭ **UpdateClaimItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id` | `string` | +| `images` | [`UpdateClaimItemImageInput`](internal-8.md#updateclaimitemimageinput)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `note?` | `string` | +| `reason?` | `string` | +| `tags` | [`UpdateClaimItemTagInput`](internal-8.md#updateclaimitemtaginput)[] | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:54 + +___ + +### UpdateClaimItemTagInput + +Ƭ **UpdateClaimItemTagInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `id?` | `string` | +| `value?` | `string` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:66 + +___ + +### UpdateClaimShippingMethodInput + +Ƭ **UpdateClaimShippingMethodInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `id?` | `string` | +| `option_id?` | `string` | +| `price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/claim.d.ts:48 + +___ + +### UpdateCurrencyInput + +Ƭ **UpdateCurrencyInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `includes_tax?` | `boolean` | + +#### Defined in + +packages/medusa/dist/types/currency.d.ts:1 + +___ + +### UpdateCustomerInput + +Ƭ **UpdateCustomerInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) \| `string` | +| `billing_address_id?` | `string` | +| `email?` | `string` | +| `first_name?` | `string` | +| `groups?` | { `id`: `string` }[] | +| `last_name?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `password?` | `string` | +| `phone?` | `string` | + +#### Defined in + +packages/medusa/dist/types/customers.d.ts:17 + +___ + +### UpdateDiscountInput + +Ƭ **UpdateDiscountInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code?` | `string` | +| `ends_at?` | `Date` \| ``null`` | +| `is_disabled?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `regions?` | `string`[] | +| `rule?` | [`UpdateDiscountRuleInput`](internal-8.md#updatediscountruleinput) | +| `starts_at?` | `Date` | +| `usage_limit?` | `number` \| ``null`` | +| `valid_duration?` | `string` \| ``null`` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:76 + +___ + +### UpdateDiscountRuleInput + +Ƭ **UpdateDiscountRuleInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allocation?` | [`AllocationType`](../enums/internal-3.AllocationType.md) | +| `conditions?` | [`DiscountConditionInput`](internal-8.md#discountconditioninput)[] | +| `description?` | `string` | +| `id` | `string` | +| `value?` | `number` | + +#### Defined in + +packages/medusa/dist/types/discount.d.ts:69 + +___ + +### UpdateGiftCardInput + +Ƭ **UpdateGiftCardInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `balance?` | `number` | +| `ends_at?` | `Date` \| ``null`` | +| `is_disabled?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/gift-card.d.ts:11 + +___ + +### UpdateInventoryLevelInput + +Ƭ **UpdateInventoryLevelInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `incoming_quantity?` | `number` | +| `stocked_quantity?` | `number` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:253 + +___ + +### UpdateOauthInput + +Ƭ **UpdateOauthInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `data` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +#### Defined in + +packages/medusa/dist/types/oauth.d.ts:7 + +___ + +### UpdateOrderInput + +Ƭ **UpdateOrderInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `billing_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | +| `customer_id?` | `string` | +| `discounts?` | `object`[] | +| `email?` | `string` | +| `fulfillment_status?` | [`FulfillmentStatus`](../enums/internal-8.FulfillmentStatus.md) | +| `items?` | `object`[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | +| `payment?` | [`Payment`](../classes/internal-3.Payment.md) | +| `payment_method?` | { `data?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `provider_id?`: `string` } | +| `payment_method.data?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `payment_method.provider_id?` | `string` | +| `payment_status?` | [`PaymentStatus`](../enums/internal-8.PaymentStatus.md) | +| `region?` | `string` | +| `shipping_address?` | [`AddressPayload`](../classes/internal.AddressPayload.md) | +| `shipping_method?` | { `data?`: [`Record`](internal.md#record)<`string`, `unknown`\> ; `items?`: [`Record`](internal.md#record)<`string`, `unknown`\>[] ; `price?`: `number` ; `profile_id?`: `string` ; `provider_id?`: `string` }[] | +| `status?` | [`OrderStatus`](../enums/internal-8.OrderStatus.md) | + +#### Defined in + +packages/medusa/dist/types/orders.d.ts:59 + +___ + +### UpdateProductCategoryInput + +Ƭ **UpdateProductCategoryInput**: [`ProductCategoryInput`](internal-8.md#productcategoryinput) & { `name?`: `string` } + +#### Defined in + +packages/medusa/dist/types/product-category.d.ts:14 + +___ + +### UpdateProductCollection + +Ƭ **UpdateProductCollection**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `handle?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `title?` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-collection.d.ts:6 + +___ + +### UpdateProductInput + +Ƭ **UpdateProductInput**: [`Omit`](internal-1.md#omit)<[`Partial`](internal-8.md#partial)<[`CreateProductInput`](internal-8.md#createproductinput)\>, ``"variants"``\> & { `variants?`: [`UpdateProductProductVariantDTO`](internal-8.md#updateproductproductvariantdto)[] } + +#### Defined in + +packages/medusa/dist/types/product.d.ts:139 + +___ + +### UpdateProductProductVariantDTO + +Ƭ **UpdateProductProductVariantDTO**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allow_backorder?` | `boolean` | +| `barcode?` | `string` | +| `ean?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `id?` | `string` | +| `inventory_quantity?` | `number` | +| `length?` | `number` | +| `manage_inventory?` | `boolean` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `mid_code?` | `string` | +| `options?` | { `option_id`: `string` ; `value`: `string` }[] | +| `origin_country?` | `string` | +| `prices?` | [`CreateProductProductVariantPriceInput`](internal-8.md#createproductproductvariantpriceinput)[] | +| `sku?` | `string` | +| `title?` | `string` | +| `upc?` | `string` | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product.d.ts:104 + +___ + +### UpdateProductVariantData + +Ƭ **UpdateProductVariantData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `updateData` | [`UpdateProductVariantInput`](internal-8.md#updateproductvariantinput) | +| `variant` | [`ProductVariant`](../classes/internal-3.ProductVariant.md) | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:67 + +___ + +### UpdateProductVariantInput + +Ƭ **UpdateProductVariantInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `allow_backorder?` | `boolean` | +| `barcode?` | `string` | +| `ean?` | `string` | +| `height?` | `number` | +| `hs_code?` | `string` | +| `inventory_quantity?` | `number` | +| `length?` | `number` | +| `manage_inventory?` | `boolean` | +| `material?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `mid_code?` | `string` | +| `options?` | [`ProductVariantOption`](internal-8.md#productvariantoption)[] | +| `origin_country?` | `string` | +| `prices?` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | +| `product_id?` | `string` | +| `sku?` | `string` | +| `title?` | `string` | +| `upc?` | `string` | +| `variant_rank?` | `number` | +| `weight?` | `number` | +| `width?` | `number` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:44 + +___ + +### UpdateRegionInput + +Ƭ **UpdateRegionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `automatic_taxes?` | `boolean` | +| `countries?` | `string`[] | +| `currency_code?` | `string` | +| `fulfillment_providers?` | `string`[] | +| `gift_cards_taxable?` | `boolean` | +| `includes_tax?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name?` | `string` | +| `payment_providers?` | `string`[] | +| `tax_code?` | `string` | +| `tax_provider_id?` | `string` \| ``null`` | +| `tax_rate?` | `number` | + +#### Defined in + +packages/medusa/dist/types/region.d.ts:1 + +___ + +### UpdateReservationItemInput + +Ƭ **UpdateReservationItemInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description?` | `string` | +| `location_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> \| ``null`` | +| `quantity?` | `number` | + +#### Defined in + +packages/types/dist/inventory/common.d.ts:261 + +___ + +### UpdateReturnInput + +Ƭ **UpdateReturnInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `items?` | [`OrdersReturnItem`](internal-8.md#ordersreturnitem)[] | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `no_notification?` | `boolean` | +| `shipping_method?` | { `option_id`: `string` ; `price?`: `number` } | +| `shipping_method.option_id` | `string` | +| `shipping_method.price?` | `number` | + +#### Defined in + +packages/medusa/dist/types/return.d.ts:21 + +___ + +### UpdateReturnReason + +Ƭ **UpdateReturnReason**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `description?` | `string` | +| `label?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `parent_return_reason_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/return-reason.d.ts:8 + +___ + +### UpdateShippingOptionInput + +Ƭ **UpdateShippingOptionInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `admin_only?` | `boolean` | +| `amount?` | `number` | +| `data?` | `string` | +| `includes_tax?` | `boolean` | +| `is_return?` | `boolean` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name?` | `string` | +| `price_type?` | [`ShippingOptionPriceType`](../enums/internal-3.ShippingOptionPriceType.md) | +| `profile_id?` | `string` | +| `provider_id?` | `string` | +| `region_id?` | `string` | +| `requirements?` | [`ShippingOptionRequirement`](../classes/internal-3.ShippingOptionRequirement.md)[] | + +#### Defined in + +packages/medusa/dist/types/shipping-options.d.ts:52 + +___ + +### UpdateShippingProfile + +Ƭ **UpdateShippingProfile**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name?` | `string` | +| `products?` | `string`[] | +| `shipping_options?` | `string`[] | +| `type?` | [`ShippingProfileType`](../enums/internal-3.ShippingProfileType.md) | + +#### Defined in + +packages/medusa/dist/types/shipping-profile.d.ts:7 + +___ + +### UpdateStockLocationInput + +Ƭ **UpdateStockLocationInput**: `Object` + +**`Schema`** + +UpdateStockLocationInput +title: "Update Stock Location Input" +description: "Represents the Input to update a Stock Location" +type: object +properties: + name: + type: string + description: The stock location name + address_id: + type: string + description: The Stock location address ID + address: + description: Stock location address object + allOf: + - $ref: "#/components/schemas/StockLocationAddressInput" + - type: object + metadata: + type: object + description: An optional key-value map with additional details + example: {car: "white"} + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `address?` | [`StockLocationAddressInput`](internal-8.md#stocklocationaddressinput) | +| `address_id?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name?` | `string` | + +#### Defined in + +packages/types/dist/stock-location/common.d.ts:257 + +___ + +### UpdateStoreInput + +Ƭ **UpdateStoreInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `currencies?` | `string`[] | +| `default_currency_code?` | `string` | +| `default_sales_channel_id?` | `string` | +| `invite_link_template?` | `string` | +| `metadata?` | [`Record`](internal.md#record)<`string`, `unknown`\> | +| `name?` | `string` | +| `payment_link_template?` | `string` | +| `swap_link_template?` | `string` | + +#### Defined in + +packages/medusa/dist/types/store.d.ts:4 + +___ + +### UpdateTaxRateInput + +Ƭ **UpdateTaxRateInput**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `code?` | `string` | +| `name?` | `string` | +| `rate?` | `number` \| ``null`` | +| `region_id?` | `string` | + +#### Defined in + +packages/medusa/dist/types/tax-rate.d.ts:11 + +___ + +### UpdateVariantPricesData + +Ƭ **UpdateVariantPricesData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prices` | [`ProductVariantPrice`](internal-8.md#productvariantprice)[] | +| `variantId` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:71 + +___ + +### UpdateVariantRegionPriceData + +Ƭ **UpdateVariantRegionPriceData**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `price` | { `amount`: `number` ; `currency_code`: `string` ; `region_id`: `string` } | +| `price.amount` | `number` | +| `price.currency_code` | `string` | +| `price.region_id` | `string` | +| `variantId` | `string` | + +#### Defined in + +packages/medusa/dist/types/product-variant.d.ts:75 + +___ + +### UploadStreamDescriptorType + +Ƭ **UploadStreamDescriptorType**: `Object` + +#### Index signature + +▪ [x: `string`]: `unknown` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `ext?` | `string` | +| `isPrivate?` | `boolean` | +| `name` | `string` | + +#### Defined in + +packages/types/dist/file-service/index.d.ts:23 + +___ + +### UpsertTagsInput + +Ƭ **UpsertTagsInput**: [`Partial`](internal-8.md#partial)<[`ProductTag`](../classes/internal-3.ProductTag.md)\> & { `value`: `string` }[] + +#### Defined in + +packages/medusa/dist/repositories/product-tag.d.ts:4 + +___ + +### UpsertTypeInput + +Ƭ **UpsertTypeInput**: [`Partial`](internal-8.md#partial)<[`ProductType`](../classes/internal-3.ProductType.md)\> & { `value`: `string` } + +#### Defined in + +packages/medusa/dist/repositories/product-type.d.ts:3 + +___ + +### UserServiceProps + +Ƭ **UserServiceProps**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `analyticsConfigService` | [`AnalyticsConfigService`](../classes/internal-8.internal.AnalyticsConfigService.md) | +| `eventBusService` | [`EventBusService`](../classes/internal-8.internal.EventBusService.md) | +| `featureFlagRouter` | [`FlagRouter`](../classes/internal-8.FlagRouter.md) | +| `manager` | `EntityManager` | +| `userRepository` | typeof [`UserRepository`](internal-8.md#userrepository) | + +#### Defined in + +packages/medusa/dist/services/user.d.ts:10 + +___ + +### WithImplicitCoercion + +Ƭ **WithImplicitCoercion**<`T`\>: `T` \| { `valueOf`: () => `T` } + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:235 + +___ + +### handler + +Ƭ **handler**: (`req`: `Request`, `res`: `Response`) => `Promise`<`void`\> + +#### Type declaration + +▸ (`req`, `res`): `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `req` | `Request` | +| `res` | `Response` | + +##### Returns + +`Promise`<`void`\> + +#### Defined in + +packages/medusa/dist/api/middlewares/await-middleware.d.ts:2 + +___ + +### middlewareHandlerType + +Ƭ **middlewareHandlerType**: (`options`: [`Record`](internal.md#record)<`string`, `unknown`\>) => `RequestHandler` + +#### Type declaration + +▸ (`options`): `RequestHandler` + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `options` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +##### Returns + +`RequestHandler` + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:2 + +___ + +### middlewareType + +Ƭ **middlewareType**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `middleware` | [`middlewareHandlerType`](internal-8.md#middlewarehandlertype) | +| `options` | [`Record`](internal.md#record)<`string`, `unknown`\> | + +#### Defined in + +packages/medusa/dist/services/middleware.d.ts:3 + +## Variables + +### AddressRepository + +• `Const` **AddressRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/address.d.ts:2 + +___ + +### AdminGetDiscountsParams\_base + +• `Const` **AdminGetDiscountsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:77 + +___ + +### AdminGetInventoryItemsParams\_base + +• `Const` **AdminGetInventoryItemsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/inventory-items/list-inventory-items.d.ts:94 + +___ + +### AdminGetPriceListsPriceListProductsParams\_base + +• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:165 + +___ + +### AdminGetProductCategoriesParams\_base + +• `Const` **AdminGetProductCategoriesParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/product-categories/list-product-categories.d.ts:67 + +___ + +### AdminGetReservationsParams\_base + +• `Const` **AdminGetReservationsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/reservations/list-reservations.d.ts:146 + +___ + +### AdminGetSalesChannelsParams\_base + +• `Const` **AdminGetSalesChannelsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:132 + +___ + +### AdminGetStockLocationsParams\_base + +• `Const` **AdminGetStockLocationsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/stock-locations/list-stock-locations.d.ts:129 + +___ + +### AnalyticsConfigRepository + +• `Const` **AnalyticsConfigRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/analytics-config.d.ts:2 + +___ + +### BatchJobRepository + +• `Const` **BatchJobRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/batch-job.d.ts:2 + +___ + +### Buffer + +• **Buffer**: [`BufferConstructor`](../interfaces/internal-8.BufferConstructor.md) + +#### Defined in + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:622 + +packages/medusa-js/node_modules/@types/node/buffer.d.ts:2305 + +___ + +### CartRepository + +• `Const` **CartRepository**: `Repository` & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](../classes/internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Cart`](../classes/internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](../classes/internal-3.Cart.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Cart`](../classes/internal-3.Cart.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Cart`](../classes/internal-3.Cart.md)\>, ``"relations"``\>) => `Promise`<[`Cart`](../classes/internal-3.Cart.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/cart.d.ts:3 + +___ + +### ClaimRepository + +• `Const` **ClaimRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/claim.d.ts:2 + +___ + +### CountryRepository + +• `Const` **CountryRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/country.d.ts:2 + +___ + +### CurrencyRepository + +• `Const` **CurrencyRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/currency.d.ts:2 + +___ + +### CustomShippingOptionRepository + +• `Const` **CustomShippingOptionRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/custom-shipping-option.d.ts:2 + +___ + +### CustomerGroupRepository + +• `Const` **CustomerGroupRepository**: `Repository` & { `addCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\> ; `findWithRelationsAndCount`: (`relations?`: `FindOptionsRelations`<[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)\>, `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions)) => `Promise`<[[`CustomerGroup`](../classes/internal-3.CustomerGroup.md)[], `number`]\> ; `removeCustomers`: (`groupId`: `string`, `customerIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/repositories/customer-group.d.ts:10 + +___ + +### CustomerRepository + +• `Const` **CustomerRepository**: `Repository` & { `listAndCount`: (`query`: `Object`, `q?`: `string`) => `Promise`<[[`Customer`](../classes/internal-3.Customer.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/repositories/customer.d.ts:4 + +___ + +### DiscountConditionRepository + +• `Const` **DiscountConditionRepository**: `Repository` & { `addConditionResources`: (`conditionId`: `string`, `resourceIds`: (`string` \| { `id`: `string` })[], `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `overrideExisting?`: `boolean`) => `Promise`<([`DiscountConditionCustomerGroup`](../classes/internal-8.internal.DiscountConditionCustomerGroup.md) \| [`DiscountConditionProduct`](../classes/internal-8.internal.DiscountConditionProduct.md) \| [`DiscountConditionProductCollection`](../classes/internal-8.internal.DiscountConditionProductCollection.md) \| [`DiscountConditionProductTag`](../classes/internal-8.internal.DiscountConditionProductTag.md) \| [`DiscountConditionProductType`](../classes/internal-8.internal.DiscountConditionProductType.md))[]\> ; `canApplyForCustomer`: (`discountRuleId`: `string`, `customerId`: `string`) => `Promise`<`boolean`\> ; `findOneWithDiscount`: (`conditionId`: `string`, `discountId`: `string`) => `Promise`<`undefined` \| [`DiscountCondition`](../classes/internal-3.DiscountCondition.md) & { `discount`: [`Discount`](../classes/internal-3.Discount.md) }\> ; `getJoinTableResourceIdentifiers`: (`type`: `string`) => { `conditionTable`: [`DiscountConditionResourceType`](internal-8.md#discountconditionresourcetype) ; `joinTable`: `string` ; `joinTableForeignKey`: [`DiscountConditionJoinTableForeignKey`](../enums/internal-8.DiscountConditionJoinTableForeignKey.md) ; `joinTableKey`: `string` ; `relatedTable`: `string` ; `resourceKey`: `string` } ; `isValidForProduct`: (`discountRuleId`: `string`, `productId`: `string`) => `Promise`<`boolean`\> ; `queryConditionTable`: (`__namedParameters`: { `conditionId`: `any` ; `resourceId`: `any` ; `type`: `any` }) => `Promise`<`number`\> ; `removeConditionResources`: (`id`: `string`, `type`: [`DiscountConditionType`](../enums/internal-3.DiscountConditionType.md), `resourceIds`: (`string` \| { `id`: `string` })[]) => `Promise`<`void` \| `DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/repositories/discount-condition.d.ts:11 + +___ + +### DraftOrderRepository + +• `Const` **DraftOrderRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/draft-order.d.ts:2 + +___ + +### FulfillmentProviderRepository + +• `Const` **FulfillmentProviderRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/fulfillment-provider.d.ts:2 + +___ + +### FulfillmentRepository + +• `Const` **FulfillmentRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/fulfillment.d.ts:2 + +___ + +### GetOrderEditsParams\_base + +• `Const` **GetOrderEditsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:62 + +___ + +### GetPublishableApiKeySalesChannelsParams\_base + +• `Const` **GetPublishableApiKeySalesChannelsParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.d.ts:58 + +___ + +### GetPublishableApiKeysParams\_base + +• `Const` **GetPublishableApiKeysParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61 + +___ + +### GiftCardRepository + +• `Const` **GiftCardRepository**: `Repository` & { `listGiftCardsAndCount`: (`query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`GiftCard`](../classes/internal-3.GiftCard.md)\>, `q?`: `string`) => `Promise`<[[`GiftCard`](../classes/internal-3.GiftCard.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/repositories/gift-card.d.ts:3 + +___ + +### GiftCardTransactionRepository + +• `Const` **GiftCardTransactionRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/gift-card-transaction.d.ts:2 + +___ + +### IdempotencyKeyRepository + +• `Const` **IdempotencyKeyRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/idempotency-key.d.ts:2 + +___ + +### ImageRepository + +• `Const` **ImageRepository**: `Repository` & { `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`Image`](../classes/internal-3.Image.md)\>[]) => `Promise`<[`Image`](../classes/internal-3.Image.md)[]\> ; `upsertImages`: (`imageUrls`: `string`[]) => `Promise`<[`Image`](../classes/internal-3.Image.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/image.d.ts:3 + +___ + +### LineItemAdjustmentRepository + +• `Const` **LineItemAdjustmentRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/line-item-adjustment.d.ts:2 + +___ + +### LineItemRepository + +• `Const` **LineItemRepository**: `Repository` & { `findByReturn`: (`returnId`: `string`) => `Promise`<[`LineItem`](../classes/internal-3.LineItem.md) & { `return_item`: [`ReturnItem`](../classes/internal-3.ReturnItem.md) }[]\> } + +#### Defined in + +packages/medusa/dist/repositories/line-item.d.ts:3 + +___ + +### LineItemTaxLineRepository + +• `Const` **LineItemTaxLineRepository**: `Repository` & { `deleteForCart`: (`cartId`: `string`) => `Promise`<`void`\> ; `upsertLines`: (`lines`: [`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]) => `Promise`<[`LineItemTaxLine`](../classes/internal-3.LineItemTaxLine.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/line-item-tax-line.d.ts:2 + +___ + +### MoneyAmountRepository + +• `Const` **MoneyAmountRepository**: `Repository` & { `addPriceListPrices`: (`priceListId`: `string`, `prices`: [`PriceListPriceCreateInput`](internal-8.internal.md#pricelistpricecreateinput)[], `overrideExisting?`: `boolean`) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `createProductVariantMoneyAmounts`: (`toCreate`: { `money_amount_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<`InsertResult`\> ; `deletePriceListPrices`: (`priceListId`: `string`, `moneyAmountIds`: `string`[]) => `Promise`<`void`\> ; `deleteVariantPricesNotIn`: (`variantIdOrData`: `string` \| { `prices`: [`ProductVariantPrice`](internal-8.md#productvariantprice)[] ; `variantId`: `string` }[], `prices?`: [`Price`](internal-8.md#price)[]) => `Promise`<`void`\> ; `findCurrencyMoneyAmounts`: (`where`: { `currency_code`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`internal`](internal-8.internal-1.md) ; `currency_code`: `string` ; `deleted_at`: `Date` \| ``null`` ; `id`: `string` ; `max_quantity`: `number` \| ``null`` ; `min_quantity`: `number` \| ``null`` ; `price_list`: [`internal`](internal-8.internal-1.md) \| ``null`` ; `price_list_id`: `string` \| ``null`` ; `region?`: [`internal`](internal-8.internal-1.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](../classes/internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] }[]\> ; `findManyForVariantInPriceList`: (`variant_id`: `string`, `price_list_id`: `string`, `requiresPriceList?`: `boolean`) => `Promise`<[[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantInRegion`: (`variant_id`: `string`, `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[], `number`]\> ; `findManyForVariantsInRegion`: (`variant_ids`: `string` \| `string`[], `region_id?`: `string`, `currency_code?`: `string`, `customer_id?`: `string`, `include_discount_prices?`: `boolean`, `include_tax_inclusive_pricing?`: `boolean`) => `Promise`<[[`Record`](internal.md#record)<`string`, [`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\>, `number`]\> ; `findRegionMoneyAmounts`: (`where`: { `region_id`: `string` ; `variant_id`: `string` }[]) => `Promise`<{ `amount`: `number` ; `created_at`: `Date` ; `currency?`: [`internal`](internal-8.internal-1.md) ; `currency_code`: `string` ; `deleted_at`: `Date` \| ``null`` ; `id`: `string` ; `max_quantity`: `number` \| ``null`` ; `min_quantity`: `number` \| ``null`` ; `price_list`: [`internal`](internal-8.internal-1.md) \| ``null`` ; `price_list_id`: `string` \| ``null`` ; `region?`: [`internal`](internal-8.internal-1.md) ; `region_id`: `string` ; `updated_at`: `Date` ; `variant`: [`ProductVariant`](../classes/internal-3.ProductVariant.md) ; `variant_id`: `any` ; `variants`: [`ProductVariant`](../classes/internal-3.ProductVariant.md)[] }[]\> ; `findVariantPricesNotIn`: (`variantId`: `string`, `prices`: [`Price`](internal-8.md#price)[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `getPricesForVariantInRegion`: (`variantId`: `string`, `regionId`: `undefined` \| `string`) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)\>[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `updatePriceListPrices`: (`priceListId`: `string`, `updates`: [`PriceListPriceUpdateInput`](internal-8.internal.md#pricelistpriceupdateinput)[]) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)[]\> ; `upsertVariantCurrencyPrice`: (`variantId`: `string`, `price`: [`Price`](internal-8.md#price)) => `Promise`<[`MoneyAmount`](../classes/internal-3.MoneyAmount.md)\> } + +#### Defined in + +packages/medusa/dist/repositories/money-amount.d.ts:8 + +___ + +### NoteRepository + +• `Const` **NoteRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/note.d.ts:2 + +___ + +### NotificationProviderRepository + +• `Const` **NotificationProviderRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/notification-provider.d.ts:2 + +___ + +### NotificationRepository + +• `Const` **NotificationRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/notification.d.ts:2 + +___ + +### OauthRepository + +• `Const` **OauthRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/oauth.d.ts:2 + +___ + +### OrderEditRepository + +• `Const` **OrderEditRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/order-edit.d.ts:2 + +___ + +### OrderItemChangeRepository + +• `Const` **OrderItemChangeRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/order-item-change.d.ts:2 + +___ + +### OrderRepository + +• `Const` **OrderRepository**: `Repository` & { `findOneWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](../classes/internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Order`](../classes/internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](../classes/internal-3.Order.md)\> ; `findWithRelations`: (`relations?`: `FindOptionsRelations`<[`Order`](../classes/internal-3.Order.md)\>, `optionsWithoutRelations?`: [`Omit`](internal-1.md#omit)<`FindManyOptions`<[`Order`](../classes/internal-3.Order.md)\>, ``"relations"``\>) => `Promise`<[`Order`](../classes/internal-3.Order.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/order.d.ts:3 + +___ + +### PaymentCollectionRepository + +• `Const` **PaymentCollectionRepository**: `Repository` & { `getPaymentCollectionIdByPaymentId`: (`paymentId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\> ; `getPaymentCollectionIdBySessionId`: (`sessionId`: `string`, `config?`: `FindManyOptions`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\>) => `Promise`<[`PaymentCollection`](../classes/internal-3.PaymentCollection.md)\> } + +#### Defined in + +packages/medusa/dist/repositories/payment-collection.d.ts:3 + +___ + +### PaymentProviderRepository + +• `Const` **PaymentProviderRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/payment-provider.d.ts:2 + +___ + +### PaymentRepository + +• `Const` **PaymentRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/payment.d.ts:2 + +___ + +### PaymentSessionRepository + +• `Const` **PaymentSessionRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/payment-session.d.ts:2 + +___ + +### PriceListRepository + +• `Const` **PriceListRepository**: `Repository` & { `listAndCount`: (`query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`PriceList`](../classes/internal-3.PriceList.md)\>, `q?`: `string`) => `Promise`<[[`PriceList`](../classes/internal-3.PriceList.md)[], `number`]\> ; `listPriceListsVariantIdsMap`: (`priceListIds`: `string` \| `string`[]) => `Promise`<{ `[priceListId: string]`: `string`[]; }\> } + +#### Defined in + +packages/medusa/dist/repositories/price-list.d.ts:3 + +___ + +### ProductCategoryRepository + +• `Const` **ProductCategoryRepository**: `TreeRepository` & { `addProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `findOneWithDescendants`: (`query`: `FindOneOptions`<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `treeScope?`: [`QuerySelector`](internal-8.internal.md#queryselector)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>) => `Promise`<``null`` \| [`ProductCategory`](../classes/internal-3.ProductCategory.md)\> ; `getFreeTextSearchResultsAndCount`: (`options?`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `q?`: `string`, `treeScope?`: [`QuerySelector`](internal-8.internal.md#queryselector)<[`ProductCategory`](../classes/internal-3.ProductCategory.md)\>, `includeTree?`: `boolean`) => `Promise`<[[`ProductCategory`](../classes/internal-3.ProductCategory.md)[], `number`]\> ; `removeProducts`: (`productCategoryId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/repositories/product-category.d.ts:4 + +___ + +### ProductCollectionRepository + +• `Const` **ProductCollectionRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductCollection`](../classes/internal-3.ProductCollection.md)\>) => `Promise`<[[`ProductCollection`](../classes/internal-3.ProductCollection.md)[], `number`]\> } + +#### Defined in + +packages/medusa/dist/repositories/product-collection.d.ts:3 + +___ + +### ProductOptionRepository + +• `Const` **ProductOptionRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/product-option.d.ts:2 + +___ + +### ProductRepository + +• `Const` **ProductRepository**: `Repository` & { `_applyCategoriesQuery`: (`qb`: `SelectQueryBuilder`<[`Product`](../classes/internal-3.Product.md)\>, `__namedParameters`: { `alias`: `any` ; `categoryAlias`: `any` ; `joinName`: `any` ; `where`: `any` }) => `SelectQueryBuilder`<[`Product`](../classes/internal-3.Product.md)\> ; `_findWithRelations`: (`__namedParameters`: { `idsOrOptionsWithoutRelations`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1) ; `relations`: `string`[] ; `shouldCount`: `boolean` ; `withDeleted`: `boolean` }) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `bulkAddToCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `bulkRemoveFromCollection`: (`productIds`: `string`[], `collectionId`: `string`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `findOneWithRelations`: (`relations?`: `string`[], `optionsWithoutRelations?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[`Product`](../classes/internal-3.Product.md)\> ; `findWithRelations`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: `string`[] \| [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `withDeleted?`: `boolean`) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> ; `findWithRelationsAndCount`: (`relations?`: `string`[], `idsOrOptionsWithoutRelations?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1)) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `getCategoryIdsFromInput`: (`categoryId?`: [`CategoryQueryParams`](internal-8.md#categoryqueryparams), `includeCategoryChildren?`: `boolean`) => `Promise`<`string`[]\> ; `getCategoryIdsRecursively`: (`productCategory`: [`ProductCategory`](../classes/internal-3.ProductCategory.md)) => `string`[] ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `relations?`: `string`[]) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `isProductInSalesChannels`: (`id`: `string`, `salesChannelIds`: `string`[]) => `Promise`<`boolean`\> ; `queryProducts`: (`optionsWithoutRelations`: [`FindWithoutRelationsOptions`](internal-8.md#findwithoutrelationsoptions-1), `shouldCount?`: `boolean`) => `Promise`<[[`Product`](../classes/internal-3.Product.md)[], `number`]\> ; `queryProductsWithIds`: (`__namedParameters`: { `entityIds`: `string`[] ; `groupedRelations`: { `[toplevel: string]`: `string`[]; } ; `order?`: { `[column: string]`: ``"ASC"`` \| ``"DESC"``; } ; `select?`: keyof [`Product`](../classes/internal-3.Product.md)[] ; `where?`: `FindOptionsWhere`<[`Product`](../classes/internal-3.Product.md)\> ; `withDeleted?`: `boolean` }) => `Promise`<[`Product`](../classes/internal-3.Product.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/product.d.ts:19 + +___ + +### ProductTagRepository + +• `Const` **ProductTagRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductTag`](../classes/internal-3.ProductTag.md)\>) => `Promise`<[[`ProductTag`](../classes/internal-3.ProductTag.md)[], `number`]\> ; `insertBulk`: (`data`: `_QueryDeepPartialEntity`<[`ProductTag`](../classes/internal-3.ProductTag.md)\>[]) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> ; `listTagsByUsage`: (`take?`: `number`) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> ; `upsertTags`: (`tags`: [`UpsertTagsInput`](internal-8.md#upserttagsinput)) => `Promise`<[`ProductTag`](../classes/internal-3.ProductTag.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/product-tag.d.ts:13 + +___ + +### ProductTypeRepository + +• `Const` **ProductTypeRepository**: `Repository` & { `findAndCountByDiscountConditionId`: (`conditionId`: `string`, `query`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`ProductType`](../classes/internal-3.ProductType.md)\>) => `Promise`<[[`ProductType`](../classes/internal-3.ProductType.md)[], `number`]\> ; `upsertType`: (`type?`: [`UpsertTypeInput`](internal-8.md#upserttypeinput)) => `Promise`<``null`` \| [`ProductType`](../classes/internal-3.ProductType.md)\> } + +#### Defined in + +packages/medusa/dist/repositories/product-type.d.ts:6 + +___ + +### ProductVariantRepository + +• `Const` **ProductVariantRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/product-variant.d.ts:8 + +___ + +### ReadableByteStreamController + +• **ReadableByteStreamController**: `Object` + +#### Call signature + +• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) + +##### Returns + +[`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableByteStreamController`](internal-8.md#readablebytestreamcontroller) | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:160 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:167 + +___ + +### ReadableStream + +• **ReadableStream**: `Object` + +#### Call signature + +• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](internal-8.md#readablestream)<`Uint8Array`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSource` | [`UnderlyingByteSource`](../interfaces/internal-8.UnderlyingByteSource.md) | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`Uint8Array`\> | + +##### Returns + +[`ReadableStream`](internal-8.md#readablestream)<`Uint8Array`\> + +• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](internal-8.md#readablestream)<`R`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSource?` | [`UnderlyingSource`](../interfaces/internal-8.UnderlyingSource.md)<`R`\> | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`R`\> | + +##### Returns + +[`ReadableStream`](internal-8.md#readablestream)<`R`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStream`](internal-8.md#readablestream)<`any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:135 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:145 + +___ + +### ReadableStreamDefaultController + +• **ReadableStreamDefaultController**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> + +##### Returns + +[`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamDefaultController`](internal-8.md#readablestreamdefaultcontroller)<`any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:171 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:177 + +___ + +### ReadableStreamDefaultReader + +• **ReadableStreamDefaultReader**: `Object` + +#### Call signature + +• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`R`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `R` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`ReadableStream`](internal-8.md#readablestream)<`R`\> | + +##### Returns + +[`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`R`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`ReadableStreamDefaultReader`](internal-8.md#readablestreamdefaultreader)<`any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:150 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:154 + +___ + +### RefundRepository + +• `Const` **RefundRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/refund.d.ts:2 + +___ + +### RegionRepository + +• `Const` **RegionRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/region.d.ts:2 + +___ + +### ReturnItemRepository + +• `Const` **ReturnItemRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/return-item.d.ts:2 + +___ + +### ReturnReasonRepository + +• `Const` **ReturnReasonRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/return-reason.d.ts:2 + +___ + +### ReturnRepository + +• `Const` **ReturnRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/return.d.ts:2 + +___ + +### SalesChannelRepository + +• `Const` **SalesChannelRepository**: `Repository` & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options?`: [`ExtendedFindConfig`](internal-8.internal.md#extendedfindconfig)<[`SalesChannel`](../classes/internal-3.SalesChannel.md)\>) => `Promise`<[[`SalesChannel`](../classes/internal-3.SalesChannel.md)[], `number`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> } + +#### Defined in + +packages/medusa/dist/repositories/sales-channel.d.ts:4 + +___ + +### SharedArrayBuffer + +• **SharedArrayBuffer**: [`SharedArrayBufferConstructor`](../interfaces/internal-8.SharedArrayBufferConstructor.md) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:22 + +docs-util/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts:40 + +___ + +### ShippingMethodRepository + +• `Const` **ShippingMethodRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/shipping-method.d.ts:2 + +___ + +### ShippingOptionRepository + +• `Const` **ShippingOptionRepository**: `Repository` & { `upsertShippingProfile`: (`shippingOptionIds`: `string`[], `shippingProfileId`: `string`) => `Promise`<[`ShippingOption`](../classes/internal-3.ShippingOption.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/shipping-option.d.ts:2 + +___ + +### ShippingOptionRequirementRepository + +• `Const` **ShippingOptionRequirementRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/shipping-option-requirement.d.ts:2 + +___ + +### ShippingProfileRepository + +• `Const` **ShippingProfileRepository**: `Repository` & { `findByProducts`: (`productIds`: `string` \| `string`[]) => `Promise`<{ `[product_id: string]`: [`ShippingProfile`](../classes/internal-3.ShippingProfile.md)[]; }\> } + +#### Defined in + +packages/medusa/dist/repositories/shipping-profile.d.ts:2 + +___ + +### StagedJobRepository + +• `Const` **StagedJobRepository**: `Repository` & { `insertBulk`: (`jobToCreates`: `_QueryDeepPartialEntity`<[`StagedJob`](../classes/internal-8.internal.StagedJob.md)\>[]) => `Promise`<[`StagedJob`](../classes/internal-8.internal.StagedJob.md)[]\> } + +#### Defined in + +packages/medusa/dist/repositories/staged-job.d.ts:3 + +___ + +### StoreGetProductCategoriesParams\_base + +• `Const` **StoreGetProductCategoriesParams\_base**: [`internal`](internal-8.internal.md) + +#### Defined in + +packages/medusa/dist/api/routes/store/product-categories/list-product-categories.d.ts:67 + +___ + +### StoreRepository + +• `Const` **StoreRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/store.d.ts:2 + +___ + +### SwapRepository + +• `Const` **SwapRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/swap.d.ts:2 + +___ + +### TaxProviderRepository + +• `Const` **TaxProviderRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/tax-provider.d.ts:2 + +___ + +### TrackingLinkRepository + +• `Const` **TrackingLinkRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/tracking-link.d.ts:2 + +___ + +### UserRepository + +• `Const` **UserRepository**: `Repository` + +#### Defined in + +packages/medusa/dist/repositories/user.d.ts:2 + +___ + +### WritableStream + +• **WritableStream**: `Object` + +#### Call signature + +• **new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](internal-8.md#writablestream)<`W`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `underlyingSink?` | [`UnderlyingSink`](../interfaces/internal-8.UnderlyingSink.md)<`W`\> | +| `strategy?` | [`QueuingStrategy`](../interfaces/internal-8.QueuingStrategy.md)<`W`\> | + +##### Returns + +[`WritableStream`](internal-8.md#writablestream)<`W`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStream`](internal-8.md#writablestream)<`any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:211 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:217 + +___ + +### WritableStreamDefaultController + +• **WritableStreamDefaultController**: `Object` + +#### Call signature + +• **new WritableStreamDefaultController**(): [`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) + +##### Returns + +[`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStreamDefaultController`](internal-8.md#writablestreamdefaultcontroller) | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:246 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:249 + +___ + +### WritableStreamDefaultWriter + +• **WritableStreamDefaultWriter**: `Object` + +#### Call signature + +• **new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`W`\> + +##### Type parameters + +| Name | Type | +| :------ | :------ | +| `W` | `any` | + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `stream` | [`WritableStream`](internal-8.md#writablestream)<`W`\> | + +##### Returns + +[`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`W`\> + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `prototype` | [`WritableStreamDefaultWriter`](internal-8.md#writablestreamdefaultwriter)<`any`\> | + +#### Defined in + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:227 + +packages/medusa-js/node_modules/@types/node/stream/web.d.ts:236 + +## Functions + +### Error + +▸ **Error**(`message?`): [`Error`](internal-8.md#error) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `message?` | `string` | + +#### Returns + +[`Error`](internal-8.md#error) + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1074 + +___ + +### Object + +▸ **Object**(): `any` + +Provides functionality common to all JavaScript objects. + +#### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:157 + +▸ **Object**(`value`): `any` + +Provides functionality common to all JavaScript objects. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `value` | `any` | + +#### Returns + +`any` + +#### Defined in + +docs-util/node_modules/typescript/lib/lib.es5.d.ts:158 diff --git a/www/apps/docs/content/references/js-client/modules/internal-9.md b/www/apps/docs/content/references/js-client/modules/internal-9.md index 903fcabfc9..e566a767cf 100644 --- a/www/apps/docs/content/references/js-client/modules/internal-9.md +++ b/www/apps/docs/content/references/js-client/modules/internal-9.md @@ -1,33 +1,25 @@ -# Namespace: internal +--- +displayed_sidebar: jsClientSidebar +--- -## Classes - -- [AdminGetGiftCardsParams](../classes/internal-9.AdminGetGiftCardsParams.md) -- [AdminPostGiftCardsGiftCardReq](../classes/internal-9.AdminPostGiftCardsGiftCardReq.md) -- [AdminPostGiftCardsReq](../classes/internal-9.AdminPostGiftCardsReq.md) +# Module: internal ## Type Aliases -### AdminGiftCardsListRes +### AdminPostInvitesPayload -Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] } +Ƭ **AdminPostInvitesPayload**: [`Omit`](internal-1.md#omit)<[`AdminPostInvitesReq`](../classes/internal-8.internal.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) } #### Defined in -medusa/dist/api/routes/admin/gift-cards/index.d.ts:14 +[packages/medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L47) ___ -### AdminGiftCardsRes +### InviteUserRolesEnum -Ƭ **AdminGiftCardsRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) | +Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` #### Defined in -medusa/dist/api/routes/admin/gift-cards/index.d.ts:10 +[packages/medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L45) diff --git a/www/apps/docs/content/references/js-client/modules/internal.md b/www/apps/docs/content/references/js-client/modules/internal.md index b7edd8f389..bb7700f2b8 100644 --- a/www/apps/docs/content/references/js-client/modules/internal.md +++ b/www/apps/docs/content/references/js-client/modules/internal.md @@ -2,229 +2,30 @@ displayed_sidebar: jsClientSidebar --- -# Namespace: internal - -## Enumerations - -- [AllocationType](../enums/internal.AllocationType.md) -- [CartType](../enums/internal.CartType.md) -- [ClaimFulfillmentStatus](../enums/internal.ClaimFulfillmentStatus.md) -- [ClaimPaymentStatus](../enums/internal.ClaimPaymentStatus.md) -- [ClaimReason](../enums/internal.ClaimReason.md) -- [ClaimType](../enums/internal.ClaimType.md) -- [DiscountConditionOperator](../enums/internal.DiscountConditionOperator.md) -- [DiscountConditionType](../enums/internal.DiscountConditionType.md) -- [DiscountRuleType](../enums/internal.DiscountRuleType.md) -- [DraftOrderStatus](../enums/internal.DraftOrderStatus.md) -- [FulfillmentStatus](../enums/internal.FulfillmentStatus.md) -- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md) -- [OrderEditStatus](../enums/internal.OrderEditStatus.md) -- [OrderStatus](../enums/internal.OrderStatus.md) -- [PaymentCollectionStatus](../enums/internal.PaymentCollectionStatus.md) -- [PaymentStatus](../enums/internal.PaymentStatus.md) -- [PriceListStatus](../enums/internal.PriceListStatus.md) -- [PriceListType](../enums/internal.PriceListType.md) -- [ProductStatus](../enums/internal.ProductStatus.md) -- [RequirementType](../enums/internal.RequirementType.md) -- [ReturnStatus](../enums/internal.ReturnStatus.md) -- [ShippingOptionPriceType](../enums/internal.ShippingOptionPriceType.md) -- [ShippingProfileType](../enums/internal.ShippingProfileType.md) -- [SwapFulfillmentStatus](../enums/internal.SwapFulfillmentStatus.md) -- [SwapPaymentStatus](../enums/internal.SwapPaymentStatus.md) +# Module: internal ## Classes -- [Address](../classes/internal.Address.md) - [AddressCreatePayload](../classes/internal.AddressCreatePayload.md) - [AddressPayload](../classes/internal.AddressPayload.md) -- [Axios](../classes/internal.Axios.md) -- [BaseEntity](../classes/internal.BaseEntity.md) -- [Cart](../classes/internal.Cart.md) -- [ClaimImage](../classes/internal.ClaimImage.md) -- [ClaimItem](../classes/internal.ClaimItem.md) -- [ClaimOrder](../classes/internal.ClaimOrder.md) -- [ClaimTag](../classes/internal.ClaimTag.md) -- [Client](../classes/internal.Client.md) -- [Country](../classes/internal.Country.md) -- [Currency](../classes/internal.Currency.md) -- [Customer](../classes/internal.Customer.md) -- [CustomerGroup](../classes/internal.CustomerGroup.md) -- [Discount](../classes/internal.Discount.md) -- [DiscountCondition](../classes/internal.DiscountCondition.md) -- [DiscountRule](../classes/internal.DiscountRule.md) -- [DraftOrder](../classes/internal.DraftOrder.md) -- [Fulfillment](../classes/internal.Fulfillment.md) -- [FulfillmentItem](../classes/internal.FulfillmentItem.md) -- [FulfillmentProvider](../classes/internal.FulfillmentProvider.md) -- [GiftCard](../classes/internal.GiftCard.md) -- [GiftCardTransaction](../classes/internal.GiftCardTransaction.md) -- [Image](../classes/internal.Image.md) -- [LineItem](../classes/internal.LineItem.md) -- [LineItemAdjustment](../classes/internal.LineItemAdjustment.md) -- [LineItemTaxLine](../classes/internal.LineItemTaxLine.md) -- [MoneyAmount](../classes/internal.MoneyAmount.md) -- [Order](../classes/internal.Order.md) -- [OrderEdit](../classes/internal.OrderEdit.md) -- [OrderItemChange](../classes/internal.OrderItemChange.md) -- [Payment](../classes/internal.Payment.md) -- [PaymentCollection](../classes/internal.PaymentCollection.md) -- [PaymentProvider](../classes/internal.PaymentProvider.md) -- [PaymentSession](../classes/internal.PaymentSession.md) -- [PriceList](../classes/internal.PriceList.md) -- [Product](../classes/internal.Product.md) -- [ProductCollection](../classes/internal.ProductCollection.md) -- [ProductOption](../classes/internal.ProductOption.md) -- [ProductOptionValue](../classes/internal.ProductOptionValue.md) -- [ProductTag](../classes/internal.ProductTag.md) -- [ProductType](../classes/internal.ProductType.md) -- [ProductVariant](../classes/internal.ProductVariant.md) -- [Refund](../classes/internal.Refund.md) -- [Region](../classes/internal.Region.md) -- [Return](../classes/internal.Return.md) -- [ReturnItem](../classes/internal.ReturnItem.md) -- [ReturnReason](../classes/internal.ReturnReason.md) -- [SalesChannel](../classes/internal.SalesChannel.md) -- [ShippingMethod](../classes/internal.ShippingMethod.md) -- [ShippingMethodTaxLine](../classes/internal.ShippingMethodTaxLine.md) -- [ShippingOption](../classes/internal.ShippingOption.md) -- [ShippingOptionRequirement](../classes/internal.ShippingOptionRequirement.md) -- [ShippingProfile](../classes/internal.ShippingProfile.md) -- [SoftDeletableEntity](../classes/internal.SoftDeletableEntity.md) - [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md) - [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md) -- [Swap](../classes/internal.Swap.md) -- [TaxLine](../classes/internal.TaxLine.md) -- [TaxProvider](../classes/internal.TaxProvider.md) -- [TaxRate](../classes/internal.TaxRate.md) -- [TrackingLink](../classes/internal.TrackingLink.md) - -## Interfaces - -- [AxiosAdapter](../interfaces/internal.AxiosAdapter.md) -- [AxiosBasicCredentials](../interfaces/internal.AxiosBasicCredentials.md) -- [AxiosDefaults](../interfaces/internal.AxiosDefaults.md) -- [AxiosError](../interfaces/internal.AxiosError.md) -- [AxiosInstance](../interfaces/internal.AxiosInstance.md) -- [AxiosInterceptorManager](../interfaces/internal.AxiosInterceptorManager.md) -- [AxiosPromise](../interfaces/internal.AxiosPromise.md) -- [AxiosProxyConfig](../interfaces/internal.AxiosProxyConfig.md) -- [AxiosRequestConfig](../interfaces/internal.AxiosRequestConfig.md) -- [AxiosRequestTransformer](../interfaces/internal.AxiosRequestTransformer.md) -- [AxiosResponse](../interfaces/internal.AxiosResponse.md) -- [AxiosResponseTransformer](../interfaces/internal.AxiosResponseTransformer.md) -- [Cancel](../interfaces/internal.Cancel.md) -- [CancelToken](../interfaces/internal.CancelToken.md) -- [Config](../interfaces/internal.Config.md) -- [HTTPResponse](../interfaces/internal.HTTPResponse.md) -- [HeadersDefaults](../interfaces/internal.HeadersDefaults.md) -- [RequestOptions](../interfaces/internal.RequestOptions.md) -- [RetryConfig](../interfaces/internal.RetryConfig.md) -- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md) - -## Enumeration Members - -### ORDER\_EDIT - -• **ORDER\_EDIT**: ``"order_edit"`` - -#### Defined in - -medusa/dist/models/payment-collection.d.ts:11 ## Type Aliases -### AxiosRequestHeaders +### Record -Ƭ **AxiosRequestHeaders**: `Record`<`string`, `string`\> +Ƭ **Record**<`K`, `T`\>: { [P in K]: T } -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:3 - -___ - -### AxiosResponseHeaders - -Ƭ **AxiosResponseHeaders**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] } - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:5 - -___ - -### Method - -Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:36 - -___ - -### RequestMethod - -Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` - -#### Defined in - -[medusa-js/src/request.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L26) - -___ - -### Response - -Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal.HTTPResponse.md) } - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L17) - -___ - -### ResponsePromise - -Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal.md#response)<`T`\>\> +Construct a type with a set of properties K of type T #### Type parameters | Name | Type | | :------ | :------ | -| `T` | `any` | +| `K` | extends keyof `any` | +| `T` | `T` | #### Defined in -[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L21) - -___ - -### ResponseType - -Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` - -#### Defined in - -medusa-js/node_modules/axios/index.d.ts:48 - -___ - -### StoreCustomersRes - -Ƭ **StoreCustomersRes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `customer` | `Omit`<[`Customer`](../classes/internal.Customer.md), ``"password_hash"``\> | - -#### Defined in - -medusa/dist/api/routes/store/customers/index.d.ts:9 +docs-util/node_modules/typescript/lib/lib.es5.d.ts:1599